From 604ddf873d99379426037734f0ffcaa33ac4e385 Mon Sep 17 00:00:00 2001 From: hrshya Date: Thu, 13 Mar 2025 14:49:21 +0530 Subject: [PATCH 1/4] feat: add stats/incr/nanmsumabs --- .../@stdlib/stats/incr/nanmsumabs/README.md | 179 ++++++++++++++++++ .../incr/nanmsumabs/benchmark/benchmark.js | 69 +++++++ .../equation_moving_sum_absolute_values.svg | 38 ++++ .../stats/incr/nanmsumabs/docs/repl.txt | 46 +++++ .../incr/nanmsumabs/docs/types/index.d.ts | 67 +++++++ .../stats/incr/nanmsumabs/docs/types/test.ts | 66 +++++++ .../stats/incr/nanmsumabs/examples/index.js | 42 ++++ .../stats/incr/nanmsumabs/lib/index.js | 60 ++++++ .../@stdlib/stats/incr/nanmsumabs/lib/main.js | 82 ++++++++ .../stats/incr/nanmsumabs/package.json | 73 +++++++ .../stats/incr/nanmsumabs/test/test.js | 174 +++++++++++++++++ 11 files changed, 896 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/img/equation_moving_sum_absolute_values.svg create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/package.json create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmsumabs/test/test.js diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md new file mode 100644 index 000000000000..bb489cb63726 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md @@ -0,0 +1,179 @@ + + +# incrnanmsumabs + +> Compute a moving sum of absolute values incrementally, ignoring `NaN` values. + +
+ +For a window of size `W`, the moving sum of absolute values is defined as + + + +```math +s = \sum_{i=0}^{W-1} |x_i| +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var incrnanmsumabs = require( '@stdlib/stats/incr/nanmsumabs' ); +``` + +#### incrnanmsumabs( window ) + +Returns an accumulator `function` which incrementally computes a moving sum of absolute values. The `window` parameter defines the number of values over which to compute the moving sum, ignoring `NaN` values. + +```javascript +var accumulator = incrnanmsumabs( 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 = incrnanmsumabs( 3 ); + +var sum = accumulator(); +// returns null + +// Fill the window... +sum = accumulator( 2.0 ); // [2.0] +// returns 2.0 + +sum = accumulator( NaN ); // [2.0] +// returns 2.0 + +sum = accumulator( -1.0 ); // [2.0, -1.0] +// returns 3.0 + +sum = accumulator( 3.0 ); // [2.0, -1.0, 3.0] +// returns 6.0 + +// Window begins sliding... +sum = accumulator( -7.0 ); // [-1.0, 3.0, -7.0] +// returns 11.0 + +sum = accumulator( -5.0 ); // [3.0, -7.0, -5.0] +// returns 15.0 + +sum = accumulator(); +// returns 15.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 randu = require( '@stdlib/random/base/randu' ); +var incrnanmsumabs = require( '@stdlib/stats/incr/nanmsumabs' ); + +var accumulator; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmsumabs( 5 ); + +// For each simulated datum, update the moving sum... +for ( i = 0; i < 100; i++ ) { + if ( randu() < 0.2 ) { + v = NaN; + } else { + v = ( randu()*100.0 ) - 50.0; + } + accumulator( v ); +} +console.log( accumulator() ); +``` + +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/stats/incr/mmeanabs`][@stdlib/stats/incr/mmeanabs]: compute a moving arithmetic mean of absolute values incrementally. +- [`@stdlib/stats/incr/msum`][@stdlib/stats/incr/msum]: compute a moving sum incrementally. +- [`@stdlib/stats/incr/sum`][@stdlib/stats/incr/sum]: compute a sum incrementally. +- [`@stdlib/stats/incr/sumabs`][@stdlib/stats/incr/sumabs]: compute a sum of absolute values incrementally. + +
+ + + + + +
+ + + +[@stdlib/stats/incr/mmeanabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmeanabs + +[@stdlib/stats/incr/msum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/msum + +[@stdlib/stats/incr/sum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sum + +[@stdlib/stats/incr/sumabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sumabs + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/benchmark/benchmark.js new file mode 100644 index 000000000000..56153902999d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/benchmark/benchmark.js @@ -0,0 +1,69 @@ +/** +* @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 randu = require( '@stdlib/random/base/randu' ); +var pkg = require( './../package.json' ).name; +var incrnanmsumabs = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanmsumabs( (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 = incrnanmsumabs( 5 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = acc( randu()-0.5 ); + 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/nanmsumabs/docs/img/equation_moving_sum_absolute_values.svg b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/img/equation_moving_sum_absolute_values.svg new file mode 100644 index 000000000000..5e26d7c0c8ba --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/img/equation_moving_sum_absolute_values.svg @@ -0,0 +1,38 @@ + +s equals sigma-summation Underscript i equals 0 Overscript upper W minus 1 Endscripts StartAbsoluteValue x Subscript i Baseline EndAbsoluteValue + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/repl.txt new file mode 100644 index 000000000000..c1ec868c242e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/repl.txt @@ -0,0 +1,46 @@ + +{{alias}}( W ) + Returns an accumulator function which incrementally computes a moving sum of + absolute values, 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 ) + 7.0 + > s = accumulator( 3.0 ) + 10.0 + > s = accumulator( -5.0 ) + 13.0 + > s = accumulator() + 13.0 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/index.d.ts new file mode 100644 index 000000000000..f4bfffd654d8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/index.d.ts @@ -0,0 +1,67 @@ +/* +* @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 of absolute values; otherwise, returns the current sum of absolute values. +* +* @param x - value +* @returns sum of absolute values +*/ +type accumulator = ( x?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes a moving sum of absolute values, ignoring `NaN` values. +* +* @param W - window size +* @throws must provide a positive integer +* @returns accumulator function +* +* @example +* var accumulator = incrnanmsumabs( 3 ); +* +* var sum = accumulator(); +* // returns null +* +* sum = accumulator( 2.0 ); +* // returns 2.0 +* +* sum = accumulator( NaN ); +* // returns 2.0 +* +* sum = accumulator( -5.0 ); +* // returns 7.0 +* +* sum = accumulator( 3.0 ); +* // returns 10.0 +* +* sum = accumulator( 5.0 ); +* // returns 13.0 +* +* sum = accumulator(); +* // returns 13.0 +*/ +declare function incrnanmsumabs( W: number ): accumulator; + + +// EXPORTS // + +export = incrnanmsumabs; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts new file mode 100644 index 000000000000..01ab4a75c0e8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/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 incrnanmsumabs from './index'; + + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanmsumabs( 3 ); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided an argument which is not a number... +{ + incrnanmsumabs( '5' ); // $ExpectError + incrnanmsumabs( true ); // $ExpectError + incrnanmsumabs( false ); // $ExpectError + incrnanmsumabs( null ); // $ExpectError + incrnanmsumabs( undefined ); // $ExpectError + incrnanmsumabs( [] ); // $ExpectError + incrnanmsumabs( {} ); // $ExpectError + incrnanmsumabs( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an invalid number of arguments... +{ + incrnanmsumabs(); // $ExpectError + incrnanmsumabs( 3, 2 ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanmsumabs( 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 = incrnanmsumabs( 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/nanmsumabs/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js new file mode 100644 index 000000000000..7ce80029d51f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js @@ -0,0 +1,42 @@ +/** +* @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 incrnanmsumabs = require( './../lib' ); + +var accumulator; +var sum; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmsumabs( 5 ); + +// For each simulated datum, update the moving sum... +console.log( '\nValue\tSum\n' ); +for ( i = 0; i < 100; i++ ) { + if ( randu() < 0.2 ) { + v = NaN; + } else { + v = ( randu()*100.0 ) - 50.0; + } + sum = accumulator( v ); + console.log( '%d\t%d', v.toFixed( 3 ), ( sum === null ) ? NaN : sum.toFixed( 3 ) ); +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/index.js new file mode 100644 index 000000000000..5093974cbd55 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/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 of absolute values incrementally, ignoring `NaN` values. +* +* @module @stdlib/stats/incr/nanmsumabs +* +* @example +* var incrnanmsumabs = require( '@stdlib/stats/incr/nanmsumabs' ); +* +* var accumulator = incrnanmsumabs( 3 ); +* +* var sum = accumulator(); +* // returns null +* +* sum = accumulator( 2.0 ); +* // returns 2.0 +* +* sum = accumulator( NaN ); +* // returns 2.0 +* +* sum = accumulator( -5.0 ); +* // returns 7.0 +* +* sum = accumulator( 3.0 ); +* // returns 10.0 +* +* sum = accumulator( -5.0 ); +* // returns 13.0 +* +* sum = accumulator(); +* // returns 13.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/main.js new file mode 100644 index 000000000000..922ca29a6424 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/lib/main.js @@ -0,0 +1,82 @@ +/** +* @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 incrmsumabs = require( '@stdlib/stats/incr/msumabs' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes a moving sum of absolute values, ignoring `NaN` values. +* +* @param {PositiveInteger} W - window size +* @throws {TypeError} must provide a positive integer +* @returns {Function} accumulator function +* +* @example +* var accumulator = incrnanmsumabs( 3 ); +* +* var sum = accumulator(); +* // returns null +* +* sum = accumulator( 2.0 ); +* // returns 2.0 +* +* sum = accumulator( NaN ); +* // returns 2.0 +* +* sum = accumulator( -5.0 ); +* // returns 7.0 +* +* sum = accumulator( 3.0 ); +* // returns 10.0 +* +* sum = accumulator( 5.0 ); +* // returns 13.0 +* +* sum = accumulator(); +* // returns 13.0 +*/ +function incrnanmsumabs( W ) { + var sum = incrmsumabs( 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 = incrnanmsumabs; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/package.json b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/package.json new file mode 100644 index 000000000000..77b4d6610a60 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/package.json @@ -0,0 +1,73 @@ +{ + "name": "@stdlib/stats/incr/nanmsumabs", + "version": "0.0.0", + "description": "Compute a moving sum of absolute values 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", + "sum", + "total", + "incremental", + "accumulator", + "moving sum", + "sliding window", + "sliding", + "window", + "moving", + "absolute", + "value", + "abs", + "math.abs", + "magnitude" + ] +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/test/test.js new file mode 100644 index 000000000000..4e0ab36035dc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/test/test.js @@ -0,0 +1,174 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var incrnanmsumabs = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanmsumabs, '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() { + incrnanmsumabs( value ); + }; + } +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.equal( typeof incrnanmsumabs( 3 ), 'function', 'returns a function' ); + t.end(); +}); + +tape( 'the accumulator function computes a moving sum of absolute values incrementally', function test( t ) { + var expected; + var actual; + var data; + var acc; + var N; + var i; + + data = [ 2.0, -3.0, 2.0, -4.0, 3.0, -4.0 ]; + N = data.length; + + acc = incrnanmsumabs( 3 ); + + actual = []; + for ( i = 0; i < N; i++ ) { + actual.push( acc( data[ i ] ) ); + } + expected = [ 2.0, 5.0, 7.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, -3.0, NaN, -5.0 ]; + acc = incrnanmsumabs( 2 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( acc(), 8.0, 'returns expected value' ); + t.end(); +}); + +tape( 'if data has yet to be provided, the accumulator function returns `null`', function test( t ) { + var acc = incrnanmsumabs( 3 ); + t.equal( acc(), null, 'returns null' ); + t.end(); +}); + +tape( 'if provided `NaN`, the accumulated value is `NaN` for at least `W` invocations', function test( t ) { + var expected; + var data; + var acc; + var v; + var i; + + acc = incrnanmsumabs( 3 ); + + data = [ + NaN, + 3.14, + 3.14, + NaN, + 3.14, + 3.14, + 3.14, + NaN, + 3.14, + 3.14, + 3.14, + NaN, + 3.14, + 3.14, + NaN, + NaN, + NaN, + NaN, + 3.14 + ]; + expected = [ + null, + 3.14, + 6.28, + 6.28, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42, + 9.42 + ]; + for ( i = 0; i < data.length; i++ ) { + v = acc( data[ i ] ); + if ( isnan( expected[ i ] ) ) { + t.equal( isnan( v ), true, 'returns expected value for window '+i ); + } else { + t.equal( v, expected[ i ], 'returns expected value for window '+i ); + } + } + t.end(); +}); From 8eaf3cecf80327edaf9a1731acf20b7fbbd69472 Mon Sep 17 00:00:00 2001 From: Harsh <149176984+hrshya@users.noreply.github.com> Date: Thu, 13 Mar 2025 14:58:02 +0530 Subject: [PATCH 2/4] Update test.ts Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com> --- .../@stdlib/stats/incr/nanmsumabs/docs/types/test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts index 01ab4a75c0e8..a257db01a902 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* 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. From 376392010be35ebead90fb1ce5de8be01cfba50c Mon Sep 17 00:00:00 2001 From: Harsh <149176984+hrshya@users.noreply.github.com> Date: Sun, 23 Mar 2025 19:03:42 +0530 Subject: [PATCH 3/4] updates README.md Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com> --- .../@stdlib/stats/incr/nanmsumabs/README.md | 30 ++----------------- 1 file changed, 3 insertions(+), 27 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md index bb489cb63726..2b8cb2e0ba9f 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/README.md @@ -115,7 +115,8 @@ sum = accumulator(); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); var incrnanmsumabs = require( '@stdlib/stats/incr/nanmsumabs' ); var accumulator; @@ -127,11 +128,7 @@ accumulator = incrnanmsumabs( 5 ); // For each simulated datum, update the moving sum... for ( i = 0; i < 100; i++ ) { - if ( randu() < 0.2 ) { - v = NaN; - } else { - v = ( randu()*100.0 ) - 50.0; - } + v = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( -50.0, 50.0 ); accumulator( v ); } console.log( accumulator() ); @@ -145,15 +142,6 @@ console.log( accumulator() );
-* * * - -## See Also - -- [`@stdlib/stats/incr/mmeanabs`][@stdlib/stats/incr/mmeanabs]: compute a moving arithmetic mean of absolute values incrementally. -- [`@stdlib/stats/incr/msum`][@stdlib/stats/incr/msum]: compute a moving sum incrementally. -- [`@stdlib/stats/incr/sum`][@stdlib/stats/incr/sum]: compute a sum incrementally. -- [`@stdlib/stats/incr/sumabs`][@stdlib/stats/incr/sumabs]: compute a sum of absolute values incrementally. -
@@ -162,18 +150,6 @@ console.log( accumulator() );
- - -[@stdlib/stats/incr/mmeanabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmeanabs - -[@stdlib/stats/incr/msum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/msum - -[@stdlib/stats/incr/sum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sum - -[@stdlib/stats/incr/sumabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/sumabs - - -
From 837811f6ead761602d6280bd45dda80774f3eb08 Mon Sep 17 00:00:00 2001 From: Harsh <149176984+hrshya@users.noreply.github.com> Date: Sun, 23 Mar 2025 19:04:41 +0530 Subject: [PATCH 4/4] update index.js Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com> --- .../@stdlib/stats/incr/nanmsumabs/examples/index.js | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js index 7ce80029d51f..620515a7c315 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmsumabs/examples/index.js @@ -18,7 +18,8 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); var incrnanmsumabs = require( './../lib' ); var accumulator; @@ -32,11 +33,7 @@ accumulator = incrnanmsumabs( 5 ); // For each simulated datum, update the moving sum... console.log( '\nValue\tSum\n' ); for ( i = 0; i < 100; i++ ) { - if ( randu() < 0.2 ) { - v = NaN; - } else { - v = ( randu()*100.0 ) - 50.0; - } + v = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( -50.0, 50.0 ); sum = accumulator( v ); console.log( '%d\t%d', v.toFixed( 3 ), ( sum === null ) ? NaN : sum.toFixed( 3 ) ); }