From 5329a1182cec9c232510271a7a3e97d17fafaa66 Mon Sep 17 00:00:00 2001 From: Tejas-963 Date: Mon, 24 Mar 2025 23:05:57 +0530 Subject: [PATCH 1/2] Adding a new package to the stats/incr/* namespace: @stdlib/stats/incr/nanmprod. --- .../@stdlib/stats/incr/nanmprod/README.md | 224 ++++++++ .../incr/nanmprod/benchmark/benchmark.js | 69 +++ .../docs/img/equation_moving_product.svg | 30 ++ .../@stdlib/stats/incr/nanmprod/docs/repl.txt | 55 ++ .../stats/incr/nanmprod/docs/types/index.d.ts | 72 +++ .../stats/incr/nanmprod/docs/types/test.ts | 66 +++ .../stats/incr/nanmprod/examples/index.js | 43 ++ .../@stdlib/stats/incr/nanmprod/lib/index.js | 60 +++ .../@stdlib/stats/incr/nanmprod/lib/main.js | 82 +++ .../@stdlib/stats/incr/nanmprod/package.json | 69 +++ .../@stdlib/stats/incr/nanmprod/test/test.js | 485 ++++++++++++++++++ 11 files changed, 1255 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/README.md create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/docs/img/equation_moving_product.svg create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/package.json create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmprod/test/test.js diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md b/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md new file mode 100644 index 000000000000..e778535b0078 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md @@ -0,0 +1,224 @@ + + +# incrnanmprod + +> Compute a moving product incrementally. + +
+ +For a window of size `W`, the moving product is defined as + + + +```math +\prod_{i=0}^{W-1} x_i +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var incrnanmprod = require( '@stdlib/stats/incr/nanmprod' ); +``` + +#### incrnanmprod + +Returns an accumulator `function` which incrementally computes a moving product. The `window` parameter defines the number of values over which to compute the moving product, ignoring `NaN` values. + +```javascript +var accumulator = incrnanmprod( 3 ); +``` + +#### accumulator( \[x] ) + +If provided an input value `x`, the accumulator function returns an updated product. If not provided an input value `x`, the accumulator function returns the current product. + +```javascript +var accumulator = incrnanmprod( 3 ); + +var p = accumulator(); +// returns null + +// Fill the window... +p = accumulator( 2.0 ); // [2.0] +// returns 2.0 + +p = accumulator( 1.0 ); // [2.0, 1.0] +// returns 2.0 + +p = accumulator( 3.0 ); // [2.0, 1.0, 3.0] +// returns 6.0 + +// Window begins sliding... +p = accumulator( -7.0 ); // [1.0, 3.0, -7.0] +// returns -21.0 + +p = accumulator( NaN ); +// returns -21.0 + +p = accumulator( -5.0 ); // [3.0, -7.0, -5.0] +// returns 105.0 + +p = accumulator(); +// returns 105.0 +``` + +Under certain conditions, overflow may be transient. + +```javascript +// Large values: +var x = 5.0e+300; +var y = 1.0e+300; + +// Tiny value: +var z = 2.0e-302; + +// Initialize an accumulator: +var accumulator = incrnanmprod( 3 ); + +var p = accumulator( x ); +// returns 5.0e+300 + +// Transient overflow: +p = accumulator( y ); +// returns Infinity + +// Recover a finite result: +p = accumulator( z ); +// returns 1.0e+299 +``` + +Similarly, under certain conditions, underflow may be transient. + +```javascript +// Tiny values: +var x = 4.0e-302; +var y = 9.0e-303; + +// Large value: +var z = 2.0e+300; + +// Initialize an accumulator: +var accumulator = incrnanmprod( 3 ); + +var p = accumulator( x ); +// returns 4.0e-302 + +// Transient underflow: +p = accumulator( y ); +// returns 0.0 + +// Recover a non-zero result: +p = accumulator( z ); +// returns 7.2e-304 +``` + +
+ + + +
+ +## 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` values 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. +- For large accumulation windows or accumulations of either large or small numbers, care should be taken to prevent overflow and underflow. Note, however, that overflow/underflow may be transient, as the accumulator does not use a double-precision floating-point number to store an accumulated product. Instead, the accumulator splits an accumulated product into a normalized **fraction** and **exponent** and updates each component separately. Doing so guards against a loss in precision. + +
+ + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var incrnanmprod = require( '@stdlib/stats/incr/mprod' ); + +var accumulator; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmprod( 5 ); + +// For each simulated datum, update the moving product... +for ( i = 0; i < 100; i++ ) { + if ( randu() < 0.2 ) { + v = NaN; + } else { + v = (randu() * 10.0) - 5.0; + } + accumulator( v ); +} +console.log( accumulator() ); +``` + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/stats/incr/nansum`][@stdlib/stats/incr/nansum]: compute a sum incrementally, ignoring NaN values. +- [`@stdlib/stats/incr/msumprod`][@stdlib/stats/incr/msumprod]: compute a moving sum of products incrementally. + +
+ + + + + +
+ + + +[@stdlib/stats/incr/nansum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/nansum + +[@stdlib/stats/incr/msumprod]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/msumprod + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmprod/benchmark/benchmark.js new file mode 100644 index 000000000000..bddde92e53f9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/benchmark/benchmark.js @@ -0,0 +1,69 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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 randu = require( '@stdlib/random/base/randu' ); +var pkg = require( './../package.json' ).name; +var incrnanmprod = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanmprod( (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 = incrnanmprod( 5 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = acc( randu() ); + 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/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/img/equation_moving_product.svg b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/img/equation_moving_product.svg new file mode 100644 index 000000000000..6805f02488ba --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/img/equation_moving_product.svg @@ -0,0 +1,30 @@ + +product Underscript i equals 0 Overscript upper W minus 1 Endscripts x Subscript i + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/repl.txt new file mode 100644 index 000000000000..427bd58f5b67 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/repl.txt @@ -0,0 +1,55 @@ + +{{alias}}( W ) + Returns an accumulator function which incrementally computes a moving + product, ignoring `NaN` values. + + The `W` parameter defines the number of values over which to compute the + moving product. + + If provided a value, the accumulator function returns an updated moving + product. If not provided a value or provided NaN value, the accumulator function returns the + current moving product. + + As `W` values 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. + + For accumulations over large windows or accumulations of large numbers, care + should be taken to prevent overflow. Note, however, that overflow/underflow + may be transient, as the accumulator does not use a double-precision + floating-point number to store an accumulated product. Instead, the + accumulator splits an accumulated product into a normalized fraction and + exponent and updates each component separately. Doing so guards against a + loss in precision. + + Parameters + ---------- + W: integer + Window size. + + Returns + ------- + acc: Function + Accumulator function. + + Examples + -------- + > var accumulator = {{alias}}( 3 ); + > var p = accumulator() + null + > p = accumulator( 2.0 ) + 2.0 + > p = accumulator( -5.0 ) + -10.0 + > p = accumulator( 3.0 ) + -30.0 + > p = accumulator( NaN ) + -30.0 + > p = accumulator( 5.0 ) + -75.0 + > p = accumulator() + -75.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/index.d.ts new file mode 100644 index 000000000000..91f7e7a26a25 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/index.d.ts @@ -0,0 +1,72 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2019 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. +*/ + +// TypeScript Version: 4.1 + +/// + +/** +* If provided a value, returns an updated product; otherwise, returns the current product. +* +* @param x - value +* @returns product +*/ +type accumulator = ( x?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes a moving product. ignoring NaN values. +* +* ## Notes +* +* - The `W` parameter defines the number of values over which to compute the moving product. +* - As `W` values 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. +* +* @param W - window size +* @throws must provide a positive integer +* @returns accumulator function +* +* @example +* var accumulator = incrnanmprod( 3 ); +* +* var p = accumulator(); +* // returns null +* +* p = accumulator( 2.0 ); +* // returns 2.0 +* +* p = accumulator( -5.0 ); +* // returns -10.0 +* +* p = accumulator( 3.0 ); +* // returns -30.0 +* +* p = accumulator( NaN ); +* // returns -30.0 +* +* p = accumulator( 5.0 ); +* // returns -75.0 +* +* p = accumulator(); +* // returns -75.0 +*/ +declare function incrnanmprod( W: number ): accumulator; + + +// EXPORTS // + +export = incrnanmprod; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/test.ts new file mode 100644 index 000000000000..4c1eb1c13e78 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/docs/types/test.ts @@ -0,0 +1,66 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2019 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. +*/ + +import incrnanmprod = require( './index' ); + + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanmprod( 3 ); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided an argument which is not a number... +{ + incrnanmprod( '5' ); // $ExpectError + incrnanmprod( true ); // $ExpectError + incrnanmprod( false ); // $ExpectError + incrnanmprod( null ); // $ExpectError + incrnanmprod( undefined ); // $ExpectError + incrnanmprod( [] ); // $ExpectError + incrnanmprod( {} ); // $ExpectError + incrnanmprod( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an invalid number of arguments... +{ + incrnanmprod(); // $ExpectError + incrnanmprod( 2, 3 ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanmprod( 3 ); + + acc(); // $ExpectType number | null + acc( 3.14 ); // $ExpectType number | null +} + +// The compiler throws an error if the returned accumulator function is provided invalid arguments... +{ + const acc = incrnanmprod( 3 ); + + acc( '5' ); // $ExpectError + acc( true ); // $ExpectError + acc( false ); // $ExpectError + acc( null ); // $ExpectError + acc( [] ); // $ExpectError + acc( {} ); // $ExpectError + acc( ( x: number ): number => x ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmprod/examples/index.js new file mode 100644 index 000000000000..9b7972e52919 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/examples/index.js @@ -0,0 +1,43 @@ +/** +* @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'; + +var randu = require( '@stdlib/random/base/randu' ); +var incrnanmprod = require( './../lib' ); + +var accumulator; +var p; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmprod( 5 ); + +// For each simulated datum, update the moving product... +console.log( '\nValue\tProduct\n' ); +for ( i = 0; i < 100; i++ ) { + if ( randu() < 0.2 ) { + v = NaN; + } else { + v = (randu() * 10.0) - 5.0; + } + p = accumulator( v ); + + console.log('%d\t%d', v.toFixed( 3 ), (p === null) ? null : p.toFixed( 3 )); +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmprod/lib/index.js new file mode 100644 index 000000000000..d12fc78758dc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/lib/index.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2018 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'; + +/** +* Compute a moving product incrementally, ignoring NaN values. +* +* @module @stdlib/stats/incr/nanmprod +* +* @example +* var incrnanmprod = require( '@stdlib/stats/incr/nanmprod' ); +* +* var accumulator = incrnanmprod( 3 ); +* +* var p = accumulator(); +* // returns null +* +* p = accumulator( 2.0 ); +* // returns 2.0 +* +* p = accumulator( -5.0 ); +* // returns -10.0 +* +* p = accumulator( 3.0 ); +* // returns -30.0 +* +* p = accumulator( NaN ); +* // returns -30.0 +* +* p = accumulator( 5.0 ); +* // returns -75.0 +* +* p = accumulator(); +* // returns -75.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmprod/lib/main.js new file mode 100644 index 000000000000..e33c9bc0f793 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/lib/main.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2020 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var mprod = require( '@stdlib/stats/incr/mprod' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes a moving product while ignoring `NaN` values. +* +* @param {PositiveInteger} W - window size +* @throws {TypeError} must provide a positive integer +* @returns {Function} accumulator function +* +* @example +* var accumulator = incrnanmprod( 3 ); +* +* var p = accumulator(); +* // returns null +* +* p = accumulator( 2.0 ); +* // returns 2.0 +* +* p = accumulator( -5.0 ); +* // returns -10.0 +* +* p = accumulator( 3.0 ); +* // returns -30.0 +* +* p = accumulator( NaN ); +* // returns -30.0 +* +* p = accumulator( 5.0 ); +* // returns -75.0 +* +* p = accumulator(); +* // returns -75.0 +*/ +function incrnanmprod( W ) { + var prod = mprod( W ); + return accumulator; + + /** + * If provided a value, the accumulator function returns an updated product. If not provided a value, the accumulator function returns the current product. + * + * @private + * @param {number} [x] - input value + * @returns {(number|null)} product or null + */ + function accumulator( x ) { + if ( arguments.length === 0 || isnan( x ) ) { + return prod(); // Ignore NaN values and return current product + } + return prod( x ); // Update product normally + } +} + + +// EXPORTS // + +module.exports = incrnanmprod; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/package.json b/lib/node_modules/@stdlib/stats/incr/nanmprod/package.json new file mode 100644 index 000000000000..ab30095daeb5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/stats/incr/mprod", + "version": "0.0.0", + "description": "Compute a moving product incrementally.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "product", + "prod", + "incremental", + "accumulator", + "moving prod", + "moving product", + "sliding window", + "sliding", + "window", + "moving" + ] +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmprod/test/test.js new file mode 100644 index 000000000000..cbaa27eca8bc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/test/test.js @@ -0,0 +1,485 @@ +/** +* @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 tape = require( 'tape' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPSILON = require( '@stdlib/constants/float64/eps' ); +var isEven = require( '@stdlib/math/base/assert/is-even' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var normal = require( '@stdlib/random/base/normal' ); +var randu = require( '@stdlib/random/base/randu' ); +var ldexp = require( '@stdlib/math/base/special/ldexp' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var incrnanmprod = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanmprod, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function throws an error if not provided a positive integer', function test( t ) { + var values; + var i; + + values = [ + '5', + -5.0, + 0.0, + 3.14, + true, + null, + void 0, + NaN, + [], + {}, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + incrnanmprod( value ); + }; + } +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.equal( typeof incrnanmprod( 3 ), 'function', 'returns a function' ); + t.end(); +}); + +tape( 'the accumulator function computes a moving product incrementally, ignoring NaN values', function test( t ) { + var expected; + var actual; + var data; + var acc; + var N; + var i; + + data = [ 2.0, NaN, 3.0, 2.0, NaN, 4.0, 3.0, NaN, 4.0 ]; + N = data.length; + + acc = incrnanmprod( 3 ); + + actual = []; + for ( i = 0; i < N; i++ ) { + actual.push( acc( data[ i ] ) ); + } + expected = [ 2.0, 2.0, 6.0, 12.0, 12.0, 24.0, 24.0, 24.0, 48.0 ]; + + t.deepEqual( actual, expected, 'returns expected incremental results' ); + t.end(); +}); + +tape( 'if not provided an input value, the accumulator function returns the current product', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, 3.0, 5.0 ]; + acc = incrnanmprod( 2 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( acc(), 15.0, 'returns expected value' ); + t.end(); +}); + +tape( 'if data has yet to be provided, the accumulator function returns `null`', function test( t ) { + var acc = incrnanmprod( 3 ); + t.equal( acc(), null, 'returns null' ); + t.end(); +}); + +tape( 'if provided `NaN`, the accumulated value is not NaN and product is calculated excluding it', function test( t ) { + var expected; + var data; + var acc; + var v; + var i; + + acc = incrnanmprod( 3 ); + + data = [ + NaN, // NaN + 3.0, // NaN, 3.0 + 3.0, // NaN, 3.0, 3.0 + NaN, // 3.0, 3.0, NaN + 3.0, // 3.0, NaN, 3.0 + 3.0, // NaN, 3.0, 3.0 + 3.0, // 3.0, 3.0, 3.0 + NaN, // 3.0, 3.0, NaN + 3.0, // 3.0, NaN, 3.0 + 3.0, // NaN, 3.0, 3.0 + 3.0, // 3.0, 3.0, 3.0 + NaN, // 3.0, 3.0, NaN + 3.0, // 3.0, NaN, 3.0 + 3.0, // NaN, 3.0, 3.0 + NaN, // 3.0, 3.0, NaN + NaN, // 3.0, NaN, NaN + NaN, // NaN, NaN, NaN + NaN, // NaN, NaN, NaN + 3.0 // NaN, NaN, 3.0 + ]; + expected = [ + null, + 3.0, + 9.0, + 9.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0, + 27.0 + ]; + for ( i = 0; i < data.length; i++ ) { + v = acc( data[ i ] ); + if ( isnan( data[i] ) ) { + t.ok(true, 'returns expected value for window ' + i); + } else { + t.equal( v, expected[ i ], 'returns expected value for window '+i ); + } + } + t.end(); +}); + +tape( 'the accumulator function incrementally computes a moving product (special series)', function test( t ) { + var acc; + var x; + var i; + + acc = incrnanmprod( 150 ); + x = 2; + + // A series of reciprocals having an even number of terms is equal to unity... + for ( i = 0; i < 150; i++ ) { + if ( isEven( i ) ) { + acc( x ); + } else { + acc( 1.0/x ); + } + } + t.equal( acc(), 1.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the accumulator function can return a result which overflows', function test( t ) { + var acc = incrnanmprod( 2 ); + + acc( 5.0e300 ); + acc( 1.0e300 ); + + t.equal( acc(), PINF, 'returns infinity' ); + t.end(); +}); + +tape( 'overflow may be transient', function test( t ) { + var expected; + var delta; + var tol; + var acc; + var x; + var y; + var z; + + expected = ldexp( 0.01, 1000 ); + + acc = incrnanmprod( 3 ); + + x = ldexp( 0.5, 1000 ); // ~5.4e300 + y = ldexp( 0.1, 1000 ); // ~1.1e300 + z = ldexp( 0.2, -1000 ); // ~1.87e-302 + + acc( x ); + acc( y ); + acc( z ); + + delta = abs( expected - acc() ); + tol = EPSILON * abs( expected ); + + t.equal( delta <= tol, true, 'within tolerance. Expected: '+expected+'. Actual: '+acc()+'. Delta: '+delta+'. Tol: '+tol+'.' ); + t.end(); +}); + +tape( 'the accumulator function can return a result which underflows', function test( t ) { + var acc = incrnanmprod( 2 ); + + acc( 4.0e-302 ); + acc( 9.0e-303 ); + + t.equal( acc(), 0.0, 'returns 0' ); + t.end(); +}); + +tape( 'underflow may be transient', function test( t ) { + var expected; + var delta; + var tol; + var acc; + var x; + var y; + var z; + + expected = ldexp( 0.01, -1000 ); + + acc = incrnanmprod( 3 ); + + x = ldexp( 0.5, -1000 ); // ~4.67e-302 + y = ldexp( 0.1, -1000 ); // ~9.33e-303 + z = ldexp( 0.2, 1000 ); // ~2.14e300 + + acc( x ); + acc( y ); + + t.equal( acc(), 0.0, 'returns 0 due to underflow' ); + + acc( z ); + + delta = abs( acc() - expected ); + tol = EPSILON * abs( expected ); + + t.equal( delta <= tol, true, 'within tolerance. Expected: '+expected+'. Actual: '+acc()+'. Delta: '+delta+'. Tol: '+tol+'.' ); + t.end(); +}); + +tape( 'if provided values of normal magnitude (i.e., far away from the extremes), the accumulator function returns results matching naive multiplication', function test( t ) { + var randn; + var prod; + var acc; + var r; + var i; + + acc = incrnanmprod( 1000 ); + + randn = normal.factory( 50.0, 10.0, { + 'seed': 1234 + }); + + prod = 1.0; + for ( i = 0; i < 1000; i++ ) { + r = randn(); + acc( r ); + prod *= r; + } + t.equal( acc(), prod, 'equals native multiplication' ); + t.end(); +}); + +tape( 'if provided `+infinity`, the accumulator function returns `+-infinity` (unless provided zero)', function test( t ) { + var acc; + var x; + var i; + + acc = incrnanmprod( 3 ); + acc( 5.0 ); + + t.equal( acc(), 5.0, 'returns expected value' ); + + acc( PINF ); + t.equal( acc(), PINF, 'returns +infinity' ); + + acc( 3.0 ); + t.equal( acc(), PINF, 'returns +infinity' ); + + acc( -4.0 ); + t.equal( acc(), NINF, 'returns -infinity' ); + + for ( i = 0; i < 100; i++ ) { + x = ( randu()*100.0 ) - 50.0; + if ( x === 0.0 ) { + continue; + } + x = acc( x ); + t.notEqual( x === PINF || x === NINF, true, 'does not return +-infinity' ); + } + t.end(); +}); + +tape( 'if provided `-infinity`, the accumulator function returns `+-infinity` (unless provided zero)', function test( t ) { + var acc; + var x; + var i; + + acc = incrnanmprod( 3 ); + acc( 5.0 ); + + t.equal( acc(), 5.0, 'returns expected value' ); + + acc( NINF ); + t.equal( acc(), NINF, 'returns -infinity' ); + + acc( 3.0 ); + t.equal( acc(), NINF, 'returns -infinity' ); + + acc( -4.0 ); + t.equal( acc(), PINF, 'returns +infinity' ); + + for ( i = 0; i < 100; i++ ) { + x = ( randu()*100.0 ) - 50.0; + if ( x === 0.0 ) { + continue; + } + x = acc( x ); + t.notEqual( x === PINF || x === NINF, true, 'does not return +-infinity' ); + } + t.end(); +}); + +tape( 'if provided `+infinity`, the accumulator function returns `NaN` if also provided a `0`', function test( t ) { + var acc; + var p; + var i; + + acc = incrnanmprod( 3 ); + acc( 5.0 ); + + t.equal( acc(), 5.0, 'returns expected value' ); + + acc( PINF ); + t.equal( acc(), PINF, 'returns +infinity' ); + + acc( 0.0 ); + t.equal( isnan( acc() ), true, 'returns NaN' ); + + acc( 3.0 ); + t.equal( isnan( acc() ), true, 'returns NaN' ); + + acc( 4.0 ); + t.equal( isnan( acc() ), false, 'does not return NaN' ); + + for ( i = 0; i < 10; i++ ) { + p = acc( i+1 ); + t.equal( isnan( p ), false, 'does not return NaN' ); + } + t.end(); +}); + +tape( 'if provided `-infinity`, the accumulator function returns `NaN` if also provided a `0`', function test( t ) { + var acc; + var p; + var i; + + acc = incrnanmprod( 3 ); + acc( 5.0 ); + + t.equal( acc(), 5.0, 'returns expected value' ); + + acc( NINF ); + t.equal( acc(), NINF, 'returns -infinity' ); + + acc( 0.0 ); + t.equal( isnan( acc() ), true, 'returns NaN' ); + + acc( 3.0 ); + t.equal( isnan( acc() ), true, 'returns NaN' ); + + acc( 4.0 ); + t.equal( isnan( acc() ), false, 'does not return NaN' ); + + for ( i = 0; i < 10; i++ ) { + p = acc( i+1 ); + t.equal( isnan( p ), false, 'does not return NaN' ); + } + t.end(); +}); + +tape( 'if provided `0`, the accumulator function returns `0` (no +-infinity)', function test( t ) { + var acc; + var p; + var i; + + acc = incrnanmprod( 3 ); + acc( 5.0 ); + + t.equal( acc(), 5.0, 'returns expected value' ); + + acc( 0.0 ); + t.equal( acc(), 0.0, 'returns 0.0' ); + + acc( 3.0 ); + t.equal( acc(), 0.0, 'returns 0.0' ); + + acc( 4.0 ); + t.equal( acc(), 0.0, 'returns 0.0' ); + + for ( i = 0; i < 10; i++ ) { + p = acc( i+1 ); + t.equal( p > 0.0, true, 'does not return 0.0' ); + } + t.end(); +}); + +tape( 'the accumulator function returns a signed zero', function test( t ) { + var acc; + var p; + var i; + + acc = incrnanmprod( 3 ); + p = acc( -0.0 ); + t.equal( isNegativeZero( p ), true, 'returns -0' ); + + p = acc( -0.0 ); + t.equal( isPositiveZero( p ), true, 'returns +0' ); + + for ( i = 0; i < 100; i++ ) { + p = acc( -0.0 ); + t.equal( isNegativeZero( p ), true, 'returns -0' ); + } + + acc = incrnanmprod( 4 ); + p = acc( -0.0 ); + t.equal( isNegativeZero( p ), true, 'returns -0' ); + + p = acc( -0.0 ); + t.equal( isPositiveZero( p ), true, 'returns +0' ); + + p = acc( -0.0 ); + t.equal( isNegativeZero( p ), true, 'returns -0' ); + + for ( i = 0; i < 100; i++ ) { + p = acc( -0.0 ); + t.equal( isPositiveZero( p ), true, 'returns +0' ); + } + + t.end(); +}); From ca9a4aa2c6fda4b8d092df39dcbd96f963e39549 Mon Sep 17 00:00:00 2001 From: Tejas Date: Wed, 26 Mar 2025 00:11:43 +0530 Subject: [PATCH 2/2] Update README.md Signed-off-by: Tejas --- lib/node_modules/@stdlib/stats/incr/nanmprod/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md b/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md index e778535b0078..173c0570242c 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md +++ b/lib/node_modules/@stdlib/stats/incr/nanmprod/README.md @@ -167,7 +167,7 @@ p = accumulator( z ); ```javascript var randu = require( '@stdlib/random/base/randu' ); -var incrnanmprod = require( '@stdlib/stats/incr/mprod' ); +var incrnanmprod = require( '@stdlib/stats/incr/nanmprod' ); var accumulator; var v;