diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/README.md b/lib/node_modules/@stdlib/stats/incr/nanmsum/README.md new file mode 100644 index 000000000000..4cbae6c1d729 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/README.md @@ -0,0 +1,146 @@ + + +# incrnanmsum + +> Compute a moving sum incrementally, ignoring `NaN` values. + +
+ +For a window of size `W`, the moving sum is defined as + + + +```math +s = \sum_{i=0}^{W-1} x_i +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var incrnanmsum = require( '@stdlib/stats/incr/nanmsum' ); +``` + +#### incrnanmsum( window ) + +Returns an accumulator function which incrementally computes a moving sum. The `window` parameter defines the number of values over which to compute the moving sum. + +```javascript +var accumulator = incrnanmsum( 3 ); +``` + +#### accumulator( \[x] ) + +If provided an input value `x`, the accumulator function returns an updated sum. If not provided an input value `x`, the accumulator function returns the current sum. + +```javascript +var accumulator = incrnanmsum( 3 ); + +var sum = accumulator(); +// returns null + +sum = accumulator( 2.0 ); +// returns 2.0 + +sum = accumulator( NaN ); +// returns 2.0 + +sum = accumulator( -5.0 ); +// returns -3.0 + +sum = accumulator( 3.0 ); +// returns 0.0 + +sum = accumulator( 5.0 ); +// returns 3.0 + +sum = accumulator(); +// returns 3.0 +``` + +
+ + + +
+ +## 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. + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var incrnanmsum = require( '@stdlib/stats/incr/nanmsum' ); + +// Initialize an accumulator: +var accumulator = incrnanmsum( 5 ); + +// For each simulated datum, update the moving sum... +var i; +for ( i = 0; i < 100; i++ ) { + accumulator( ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( -50.0, 50.0 ) ); +} +console.log( accumulator() ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmsum/benchmark/benchmark.js new file mode 100644 index 000000000000..b21182fdcfa7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/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 incrnanmsum = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanmsum( (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 = incrnanmsum( 5 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = acc( (i%5) ? i : NaN ); + 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/nanmsum/docs/img/equation_moving_sum.svg b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/img/equation_moving_sum.svg new file mode 100644 index 000000000000..9f45d43680a6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/img/equation_moving_sum.svg @@ -0,0 +1,35 @@ + +s equals sigma-summation 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/nanmsum/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/repl.txt new file mode 100644 index 000000000000..742304ec2452 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/repl.txt @@ -0,0 +1,45 @@ + +{{alias}}( W ) + Returns an accumulator function which incrementally computes a moving sum, + ignoring `NaN` values. + + The `W` parameter defines the number of values over which to compute the + moving sum. + + If provided a value, the accumulator function returns an updated moving sum. + If not provided a value, the accumulator function returns the current moving + sum. + + 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. + + Parameters + ---------- + W: integer + Window size. + + Returns + ------- + acc: Function + Accumulator function. + + Examples + -------- + > var accumulator = {{alias}}( 3 ); + > var s = accumulator() + null + > s = accumulator( 2.0 ) + 2.0 + > s = accumulator( NaN ) + 2.0 + > s = accumulator( -5.0 ) + -3.0 + > s = accumulator( 3.0 ) + 0.0 + > s = accumulator() + 0.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/types/index.d.ts new file mode 100644 index 000000000000..8a2ecb9a4596 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/types/index.d.ts @@ -0,0 +1,73 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/// + +/** +* If provided a value, returns an updated sum; otherwise, returns the current sum. +* +* @param x - value +* @returns sum +*/ +type accumulator = ( x?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes a moving sum , ignoring `NaN` values. +* +* ## Notes +* +* - The `W` parameter defines the number of values over which to compute the moving sum. +* - 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 +* @returns accumulator function +* +* @example +* var nanmsum = require( '@stdlib/stats/incr/nanmsum' ); +* +* var accumulator = incrnanmsum( 3 ); +* +* var v = accumulator(); +* // returns null +* +* v = accumulator( 2.0 ); +* // returns 2.0 +* +* v = accumulator( NaN ); +* // returns 2.0 +* +* v = accumulator( -5.0 ); +* // returns -3.0 +* +* v = accumulator( 3.0 ); +* // returns 0.0 +* +* v = accumulator( 5.0 ); +* // returns 3.0 +* +* v = accumulator(); +* // returns 3.0 +*/ +declare function incrnanmsum( W: number ): accumulator; + + +// EXPORTS // + +export = incrnanmsum; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/types/test.ts new file mode 100644 index 000000000000..87b109018df0 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/docs/types/test.ts @@ -0,0 +1,54 @@ +/* +* @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. +*/ + +import incrnanmsum = require( './index' ); + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanmsum( 3 ); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided arguments... +{ + incrnanmsum( '5' ); // $ExpectError + incrnanmsum( true ); // $ExpectError + incrnanmsum( false ); // $ExpectError + incrnanmsum( null ); // $ExpectError + incrnanmsum( undefined ); // $ExpectError + incrnanmsum( [] ); // $ExpectError + incrnanmsum( {} ); // $ExpectError + incrnanmsum( ( x: number ): number => x ); // $ExpectError +} + + +// The compiler throws an error if the function is provided an invalid number of arguments... +{ + incrnanmsum(); // $ExpectError + incrnanmsum( 3, 2 ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanmsum( 3 ); + + acc(); // $ExpectType number | null + acc( 3.14 ); // $ExpectType number | null + acc( NaN ); // $ExpectType number | null +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmsum/examples/index.js new file mode 100644 index 000000000000..743c15b16a66 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/examples/index.js @@ -0,0 +1,37 @@ +/** +* @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 uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var incrnanmsum = require( './../lib' ); + +// Initialize an accumulator: +var accumulator = incrnanmsum( 5 ); + +// For each simulated datum, update the moving sum... +console.log( '\nValue\tSum\n' ); +var sum; +var v; +var i; +for ( i = 0; i < 100; i++ ) { + v = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( -50.0, 50.0 ); + sum = accumulator( v ); + console.log( '%d\t%d', v.toFixed( 4 ), sum.toFixed( 4 ) ); +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmsum/lib/index.js new file mode 100644 index 000000000000..34d7ad9141d5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/lib/index.js @@ -0,0 +1,60 @@ +/** +* @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'; + +/** +* Compute a moving sum incrementally, ignoring `NaN` values. +* +* @module @stdlib/stats/incr/nanmsum +* +* @example +* var nanmsum = require( '@stdlib/stats/incr/nanmsum' ); +* +* var accumulator = incrnanmsum( 3 ); +* +* var sum = accumulator(); +* // returns null +* +* sum = accumulator( 2.0 ); +* // returns 2.0 +* +* sum = accumulator( NaN ); +* // returns 2.0 +* +* sum = accumulator( -5.0 ); +* // returns -3.0 +* +* sum = accumulator( 3.0 ); +* // returns 0.0 +* +* sum = accumulator( 5.0 ); +* // returns 3.0 +* +* sum = accumulator(); +* // returns 3.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmsum/lib/main.js new file mode 100644 index 000000000000..e6d96efec0ba --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/lib/main.js @@ -0,0 +1,83 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var incrmsum = require( '@stdlib/stats/incr/msum' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes a moving sum, ignoring `NaN` values. +* +* @param {PositiveInteger} W - window size +* @returns {Function} accumulator function +* +* @example +* var nanmsum = require( '@stdlib/stats/incr/nanmsum' ); +* +* var accumulator = incrnanmsum( 3 ); +* +* var sum = accumulator(); +* // returns null +* +* sum = accumulator( 2.0 ); +* // returns 2.0 +* +* sum = accumulator( NaN ); +* // returns 2.0 +* +* sum = accumulator( -5.0 ); +* // returns -3.0 +* +* sum = accumulator( 3.0 ); +* // returns 0.0 +* +* sum = accumulator( 5.0 ); +* // returns 3.0 +* +* sum = accumulator(); +* // returns 3.0 +*/ +function incrnanmsum( W ) { + var sum = incrmsum( W ); + return accumulator; + + /** + * If provided a value, the accumulator function returns an updated sum. If not provided a value, the accumulator function returns the current sum. + * + * @private + * @param {number} [x] - input value + * @returns {(number|null)} sum or null + */ + function accumulator( x ) { + if ( arguments.length === 0 || isnan( x ) ) { + return sum(); + } + return sum( x ); + } +} + + +// EXPORTS // + +module.exports = incrnanmsum; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/package.json b/lib/node_modules/@stdlib/stats/incr/nanmsum/package.json new file mode 100644 index 000000000000..db2b29e620a8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/package.json @@ -0,0 +1,64 @@ +{ + "name": "@stdlib/stats/incr/nanmsum", + "version": "0.0.0", + "description": "Compute a moving sum incrementally, ignoring NaN values.", + "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", + "summation", + "sum", + "total", + "incremental", + "accumulator" + ] +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsum/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmsum/test/test.js new file mode 100644 index 000000000000..e200a742d34b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsum/test/test.js @@ -0,0 +1,111 @@ +/** +* @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 incrnanmsum = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanmsum, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.equal( typeof incrnanmsum( 3 ), 'function', 'returns a function' ); + t.end(); +}); + +tape( 'the initial accumulated value is `null`', function test( t ) { + var acc = incrnanmsum( 3 ); + t.equal( acc(), null, 'returns expected value' ); + 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() { + incrnanmsum( value ); + }; + } +}); + +tape( 'the accumulator function computes a moving sum incrementally', function test( t ) { + var expected; + var actual; + var data; + var acc; + var N; + var i; + + data = [ 2.0, 3.0, NaN, 4.0, NaN, 4.0 ]; + N = data.length; + + acc = incrnanmsum( 3 ); + + actual = []; + for ( i = 0; i < N; i++ ) { + actual.push( acc( data[ i ] ) ); + } + expected = [ 2.0, 5.0, 5.0, 9.0, 9.0, 11.0 ]; + + t.deepEqual( actual, expected, 'returns expected incremental results' ); + t.end(); +}); + +tape( 'if not provided an input value, the accumulator function returns the current sum', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, NaN, -5.0, 3.0, 5.0 ]; + acc = incrnanmsum( 3 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( acc(), 3.0, 'returns expected value' ); + t.end(); +});