stdlib-js · Girish-Garg · Mar 16, 2025 · Apr 29, 2025 · Apr 30, 2025 · Apr 30, 2025
diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumprod/README.md b/lib/node_modules/@stdlib/stats/incr/nanmsumprod/README.md
@@ -0,0 +1,177 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# incrnanmsumprod
+
+> Compute a moving sum of products incrementally, ignoring `NaN` values.
+
+<section class="intro">
+
+For a window of size `W`, the moving sum of products is defined as
+
+<!-- <equation class="equation" label="eq:moving_sum_product" align="center" raw="s = \sum_{i=0}^{W-1} x_i y_i" alt="Equation for the moving sum of products."> -->
+
+```math
+s = \sum_{i=0}^{W-1} x_i y_i
+```
+
+<!-- <div class="equation" align="center" data-raw-text="s = \sum_{i=0}^{W-1} x_i y_i" data-equation="eq:moving_sum_product">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@49d8cabda84033d55d7b8069f19ee3dd8b8d1496/lib/node_modules/@stdlib/stats/incr/nanmsumprod/docs/img/equation_moving_sum_product.svg" alt="Equation for the moving sum of products.">
+    <br>
+</div> -->
+
+<!-- </equation> -->
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var incrnanmsumprod = require( '@stdlib/stats/incr/nanmsumprod' );
+```
+
+#### incrnanmsumprod( window )
+
+Returns an accumulator function which incrementally computes a moving sum of products. The `window` parameter defines the number of values over which to compute the moving sum of products, ignoring `NaN` values.
+
+```javascript
+var accumulator = incrnanmsumprod( 4 );
+```
+
+#### accumulator( \[x, y] )
+
+If provided input values `x` and `y`, the accumulator function returns an updated sum. If not provided input values `x` and `y`, the accumulator function returns the current sum.
+
+```javascript
+var accumulator = incrnanmsumprod( 3 );
+
+var sum = accumulator();
+// returns null
+
+// Fill the window...
+sum = accumulator( 2.0, 3.0 ); // [(2.0,3.0)]
+// returns 6.0
+
+sum = accumulator( 1.0, -1.0 ); // [(2.0,3.0), (1.0,-1.0)]
+// returns 5.0
+
+sum = accumulator( NaN, -1.0 );
+// returns 5.0
+
+sum = accumulator( -3.0, 5.0 ); // [(2.0,3.0), (1.0,-1.0), (-3.0,5.0)]
+// returns -10.0
+
+// Window begins sliding...
+sum = accumulator( -7.0, -1.0 ); // [(1.0,-1.0), (-3.0,5.0), (-7.0,-1.0)]
+// returns -9.0
+
+sum = accumulator( 5.0, 4.0 ); // [(-3.0,5.0), (-7.0,-1.0), (5.0,4.0)]
+// returns 12.0
+
+sum = accumulator( 5.0, NaN );
+// returns 12.0
+
+sum = accumulator();
+// returns 12.0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   Input values are **not** type checked. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
+-   As `W` (x,y) pairs are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var incrnanmsumprod = require( '@stdlib/stats/incr/nanmsumprod' );
+
+// Initialize an accumulator:
+var accumulator = incrnanmsumprod( 5 );
+
+// For each simulated datum, update the moving sum-product...
+console.log( '\nValue\tValue\tSum\n' );
+var v1;
+var v2;
+var i;
+for ( i = 0; i < 100; i++ ) {
+    v1 = ( randu() < 0.2 ) ? NaN : randu() * 100.0;
+    v2 = ( randu() < 0.2 ) ? NaN : randu() * 100.0;
+    accumulator( v1, v2 );
+}
+console.log( accumulator() );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/stats/incr/mprod`][@stdlib/stats/incr/mprod]</span><span class="delimiter">: </span><span class="description">compute a moving product incrementally.</span>
+-   <span class="package-name">[`@stdlib/stats/incr/msum`][@stdlib/stats/incr/msum]</span><span class="delimiter">: </span><span class="description">compute a moving sum incrementally.</span>
+-   <span class="package-name">[`@stdlib/stats/incr/sumprod`][@stdlib/stats/incr/sumprod]</span><span class="delimiter">: </span><span class="description">compute a sum of products incrementally.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+<!-- <related-links> -->
+
+[@stdlib/stats/incr/mprod]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mprod
+
+[@stdlib/stats/incr/msum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/msum
+
+[@stdlib/stats/incr/sumprod]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sumprod
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->
diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumprod/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmsumprod/benchmark/benchmark.js
@@ -0,0 +1,68 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var pkg = require( './../package.json' ).name;
+var incrmsumprod = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var f;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		f = incrmsumprod( (i%5)+1 );
+		if ( typeof f !== 'function' ) {
+			b.fail( 'should return a function' );
+		}
+	}
+	b.toc();
+	if ( typeof f !== 'function' ) {
+		b.fail( 'should return a function' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::accumulator', function benchmark( b ) {
+	var acc;
+	var v;
+	var i;
+
+	acc = incrmsumprod( 5 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = acc( i, i );
+		if ( v !== v ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( v !== v ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
diff --git a/...modules/@stdlib/stats/incr/nanmsumprod/docs/img/equation_moving_sum_product.svg b/...modules/@stdlib/stats/incr/nanmsumprod/docs/img/equation_moving_sum_product.svg
diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumprod/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmsumprod/docs/repl.txt
@@ -0,0 +1,51 @@
+
+{{alias}}( W )
+    Returns an accumulator function which incrementally computes a moving sum of
+    products, ignoring `NaN` values.
+
+    The `W` parameter defines the number of (x,y) pairs over which to compute
+    the moving sum of products.
+
+    If provided input values, the accumulator function returns an updated moving
+    sum. If not provided input values, the accumulator function returns the
+    current moving sum.
+
+    As `W` (x,y) pairs are needed to fill the window buffer, the first `W-1`
+    returned values are calculated from smaller sample sizes. Until the window
+    is full, each returned value is calculated from all provided values.
+
+    Parameters
+    ----------
+    W: integer
+        Window size.
+
+    Returns
+    -------
+    acc: Function
+        Accumulator function.
+
+    Examples
+    --------
+    > var accumulator = {{alias}}( 3 );
+    > var s = accumulator()
+    null
+    > s = accumulator( 2.0, 3.0 )
+    6.0
+    > s = accumulator( NaN, 3.0 )
+    6.0
+    > s = accumulator( -5.0, 2.0 )
+    -4.0
+    > s = accumulator( -5.0, NaN )
+    -4.0
+    > s = accumulator( 3.0, -2.0 )
+    -10.0
+    > s = accumulator( NaN, NaN )
+    -10.0
+    > s = accumulator( 5.0, 3.0 )
+    -1.0
+    > s = accumulator()
+    -1.0
+
+    See Also
+    --------
+