From e979c2db7f70c323c96ed49100e68a3ceecaa6ce Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 16:35:04 +0530 Subject: [PATCH 01/11] feat: /lib implementation --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/incr/nanmmax/lib/index.js | 60 +++++++++++++ .../@stdlib/stats/incr/nanmmax/lib/main.js | 87 +++++++++++++++++++ .../@stdlib/stats/incr/nanmmax/package.json | 69 +++++++++++++++ 3 files changed, 216 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/package.json diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js new file mode 100644 index 000000000000..979c3c7e35bf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/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 maximum incrementally, ignoring 'NaN' values. +* +* @module @stdlib/stats/incr/nanmmax +* +* @example +* var incrmmax = require( '@stdlib/stats/incr/nanmmax' ); +* +* var accumulator = incrmmax( 3 ); +* +* var m = accumulator(); +* // returns null +* +* m = accumulator( 2.0 ); +* // returns 2.0 +* +* m = accumulator( -5.0 ); +* // returns 2.0 +* +* m = accumulator( 3.0 ); +* // returns 3.0 +* +* m = accumulator( NaN ); +* // returns 3.0 +* +* m = accumulator( 5.0 ); +* // returns 5.0 +* +* m = accumulator(); +* // returns 5.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js new file mode 100644 index 000000000000..0b2b207d29b7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js @@ -0,0 +1,87 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var incrmmax = require( '@stdlib/stats/incr/mmax' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes a moving maximum value, ignoring `NaN` values. +* +* @param {PositiveInteger} W - window size +* @throws {TypeError} must provide a positive integer +* @returns {Function} accumulator function +* +* @example +* var incrnanmmax = require( '@stdlib/stats/incr/nanmmax' ); +* +* var accumulator = incrnanmmax( 3 ); +* +* var m = accumulator(); +* // returns null +* +* m = accumulator( 2.0 ); +* // returns 2.0 +* +* m = accumulator( -5.0 ); +* // returns 2.0 +* +* m = accumulator( 3.0 ); +* // returns 3.0 +* +* m = accumulator( NaN ); +* // returns 3.0 +* +* m = accumulator( 5.0 ); +* // returns 5.0 +* +* m = accumulator(); +* // returns 5.0 +*/ +function incrnanmmax( W ) { + var acc = incrmmax( W ); + return accumulator; + + /** + * If provided a value, the accumulator function returns an updated maximum. If not provided a value, the accumulator function returns the current maximum. + * + * @private + * @param {number} [x] - input value + * @returns {(number|null)} maximum value or null + */ + function accumulator( x ) { + if ( arguments.length === 0 ) { + return acc(); + } + if ( isnan( x ) ) { + return acc(); + } + return acc( x ); + } +} + + +// EXPORTS // + +module.exports = incrnanmmax; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json b/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json new file mode 100644 index 000000000000..270d5e27733e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/stats/incr/nanmmax", + "version": "0.0.0", + "description": "Compute a moving maximum 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", + "maximum", + "max", + "range", + "extremes", + "domain", + "extent", + "incremental", + "accumulator", + "nan", + "ignore" + ] +} From 4a7ac8c47974cb4a8075051c7fbaa98d0335c4e5 Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 18:00:31 +0530 Subject: [PATCH 02/11] feat: add type declaration at /docs/types/index.d.ts --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/incr/nanmmax/docs/types/index.d.ts | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/index.d.ts diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/index.d.ts new file mode 100644 index 000000000000..091a20128c03 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/index.d.ts @@ -0,0 +1,72 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 maximum value; otherwise, returns the current maximum value. +* +* @param x - value +* @returns maximum value +*/ +type accumulator = ( x?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes a moving maximum value, ignoring `NaN` values. +* +* ## Notes +* +* - The `W` parameter defines the number of values over which to compute the moving maximum. +* - 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 = incrnanmmax( 3 ); +* +* var m = accumulator(); +* // returns null +* +* m = accumulator( 2.0 ); +* // returns 2.0 +* +* m = accumulator( NaN ); +* // returns 2.0 +* +* m = accumulator( -5.0 ); +* // returns 2.0 +* +* m = accumulator( 3.0 ); +* // returns 3.0 +* +* m = accumulator( 5.0 ); +* // returns 5.0 +* +* m = accumulator(); +* // returns 5.0 +*/ +declare function incrnanmmax( W: number ): accumulator; + + +// EXPORTS // + +export = incrnanmmax; From 7f4f5de3f868d80c4456eee3691428ec241931c9 Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 21:49:31 +0530 Subject: [PATCH 03/11] feat: add README.md --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/incr/nanmmax/README.md | 137 ++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/README.md diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/README.md b/lib/node_modules/@stdlib/stats/incr/nanmmax/README.md new file mode 100644 index 000000000000..28c3992d4b77 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/README.md @@ -0,0 +1,137 @@ + + +# incrnanmmax + +> Compute a moving maximum value incrementally, ignoring `NaN` values. + +
+ +## Usage + +```javascript +var incrnanmmax = require( '@stdlib/stats/incr/nanmmax' ); +``` + +#### incrnanmmax( window ) + +Returns an accumulator `function` which incrementally computes a moving maximum value. The `window` parameter defines the number of values over which to compute the moving maximum, ignoring `NaN` values. + +```javascript +var accumulator = incrnanmmax( 3 ); +``` + +#### accumulator( \[x] ) + +If provided an input value `x`, the accumulator function returns an updated maximum value. If not provided an input value `x`, the accumulator function returns the current maximum value. + +```javascript +var accumulator = incrnanmmax( 3 ); + +var m = accumulator(); +// returns null + +// Fill the window... +m = accumulator( 2.0 ); // [2.0] +// returns 2.0 + +m = accumulator( 1.0 ); // [2.0, 1.0] +// returns 2.0 + +m = accumulator( NaN ); +// returns 2.0 + +m = accumulator( 3.0 ); // [2.0, 1.0, 3.0] +// returns 3.0 + +// Window begins sliding... +m = accumulator( -7.0 ); // [1.0, 3.0, -7.0] +// returns 3.0 + +m = accumulator( -5.0 ); // [3.0, -7.0, -5.0] +// returns 3.0 + +m = 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 randu = require( '@stdlib/random/base/randu' ); +var incrnanmmax = require( '@stdlib/stats/incr/nanmmax' ); + +var accumulator; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmmax( 5 ); + +// For each simulated datum, update the moving maximum... +for ( i = 0; i < 100; i++ ) { + v = ( randu() < 0.1 ) ? NaN : randu() * 100.0; + accumulator( v ); +} +console.log( accumulator() ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ + + + + +
+ + From 5ee546dc71566456e6d474f79d2fdfb449e19c9e Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 21:56:12 +0530 Subject: [PATCH 04/11] feat: add /test/test.js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/incr/nanmmax/test/test.js | 190 ++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js new file mode 100644 index 000000000000..31323836330e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js @@ -0,0 +1,190 @@ +/** +* @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 isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var incrmmax = require( '@stdlib/stats/incr/mmax' ); +var incrnanmmax = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanmmax, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.equal( typeof incrnanmmax( 3 ), 'function', 'returns a function' ); + t.end(); +}); + +tape( 'if not provided any values, the initial returned maximum value is `null`', function test( t ) { + var acc = incrnanmmax( 3 ); + t.equal( acc(), null, 'returns null' ); + 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, + false, + 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() { + incrmmax( value ); + }; + } +}); + +tape( 'the accumulator function incrementally computes a maximum value', function test( t ) { + var expected; + var actual; + var data; + var acc; + var max; + var N; + var d; + var i; + + data = [ 2.0, 3.0, NaN, 1.0, 4.0, NaN, 3.0, 4.0 ]; + N = data.length; + + expected = []; + actual = []; + + acc = incrnanmmax( 3 ); + + max = data[ 0 ]; + for ( i = 0; i < N; i++ ) { + d = data[ i ]; + if ( isnan( d ) === false ) { + if ( max === null || d > max ) { + max = d; + } + } + expected.push( max ); + actual.push( acc( d ) ); + } + t.deepEqual( actual, expected, 'returns expected incremental results' ); + t.end(); +}); + +tape( 'if not provided an input value, the accumulator function returns the current maximum value', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, NaN, 1.0, NaN, 3.0 ]; + acc = incrnanmmax( 3 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( acc(), 3.0, 'returns the current accumulated maximum value' ); + t.end(); +}); + +tape( 'the accumulator function correctly handles signed zeros', function test( t ) { + var expected; + var data; + var acc; + var v; + var i; + + acc = incrnanmmax( 3 ); + + data = [ + -0.0, // -0 + 0.0, // -0, 0 + -0.0, // -0, 0, -0 + -0.0, // 0, -0, -0 + -0.0, // -0, -0, -0 + 0.0, // -0, -0, 0 + -0.0, // -0, 0, -0 + -0.0, // 0, -0, -0 + -0.0, // -0, -0, -0 + 0.0, // -0, -0, 0 + 0.0, // -0, 0, 0 + 0.0, // 0, 0, 0 + -0.0 // 0, 0, -0 + ]; + expected = [ + -0.0, + 0.0, + 0.0, + 0.0, + -0.0, + 0.0, + 0.0, + 0.0, + -0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ]; + for ( i = 0; i < data.length; i++ ) { + v = acc( data[ i ] ); + if ( isPositiveZero( expected[ i ] ) ) { + t.strictEqual( isPositiveZero( v ), true, 'returns expected value for window '+i ); + } else { + t.strictEqual( isNegativeZero( v ), true, 'returns expected value for window '+i ); + } + } + t.end(); +}); + +tape( 'if provided a `NaN`, the accumulator function ignores it and maintains the current maximum', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, NaN, 1.0, 2.0, 3.0, NaN, 5.0, 6.0, 7.0 ]; + acc = incrnanmmax( 3 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( isnan( acc() ), false, 'returns expected value' ); + t.end(); +}); From db2e897fa5bf273b9171160de6b4e51f660e8db3 Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 22:04:41 +0530 Subject: [PATCH 05/11] feat: add /docs/types/test.ts --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../stats/incr/nanmmax/docs/types/test.ts | 66 +++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/test.ts diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/test.ts new file mode 100644 index 000000000000..cb62c22c0173 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/types/test.ts @@ -0,0 +1,66 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 incrnanmmax = require( './index' ); + + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanmmax( 3 ); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided an argument which is not a number... +{ + incrnanmmax( '5' ); // $ExpectError + incrnanmmax( true ); // $ExpectError + incrnanmmax( false ); // $ExpectError + incrnanmmax( null ); // $ExpectError + incrnanmmax( undefined ); // $ExpectError + incrnanmmax( [] ); // $ExpectError + incrnanmmax( {} ); // $ExpectError + incrnanmmax( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an invalid number of arguments... +{ + incrnanmmax(); // $ExpectError + incrnanmmax( 3, 2 ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanmmax( 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 = incrnanmmax( 3 ); + + acc( '5' ); // $ExpectError + acc( true ); // $ExpectError + acc( false ); // $ExpectError + acc( null ); // $ExpectError + acc( [] ); // $ExpectError + acc( {} ); // $ExpectError + acc( ( x: number ): number => x ); // $ExpectError +} From d56936b9877bf6b68e11e7bd76db8a88e63dea24 Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 22:10:08 +0530 Subject: [PATCH 06/11] feat: add examples/index.js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/incr/nanmmax/examples/index.js | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/examples/index.js diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/examples/index.js new file mode 100644 index 000000000000..7bae9a56854b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/examples/index.js @@ -0,0 +1,39 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var incrnanmmax = require( './../lib' ); + +var accumulator; +var m; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmmax( 5 ); + +// For each simulated datum, update the moving maximum... +console.log( '\nValue\tMax\n' ); +for ( i = 0; i < 100; i++ ) { + v = ( randu() < 0.1 ) ? NaN : randu() * 100.0; + m = accumulator( v ); + console.log( '%s\t%s', ( isnan( v ) ) ? 'NaN' : v.toFixed( 4 ), ( m === null ) ? 'null' : m.toFixed( 4 ) ); +} From 57d8566a8d175065ff54e662bb52bab08c9408cd Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 22:17:57 +0530 Subject: [PATCH 07/11] feat: add /benchmark/benchmark.js --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/incr/nanmmax/benchmark/benchmark.js | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js new file mode 100644 index 000000000000..b973541d08eb --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js @@ -0,0 +1,69 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 incrnanmmax = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanmmax( (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 = incrnanmmax( 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(); +}); From bad220ddd56398c0f287cd15092ddc7d160e6f4d Mon Sep 17 00:00:00 2001 From: Arjan Date: Sat, 18 Jul 2026 22:21:10 +0530 Subject: [PATCH 08/11] feat: add /docs/repl.txt --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/incr/nanmmax/docs/repl.txt | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt new file mode 100644 index 000000000000..783b0fe71a9c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt @@ -0,0 +1,45 @@ +{{alias}}( W ) + Returns an accumulator function which incrementally computes a moving + maximum value, ignoring `NaN` values. + + The `W` parameter defines the number of values over which to compute the + moving maximum. + + If provided a value, the accumulator function returns an updated moving + maximum. If not provided a value, the accumulator function returns the + current moving maximum. + + 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 m = accumulator() + null + > m = accumulator( 2.0 ) + 2.0 + > m = accumulator( NaN ) + 2.0 + > m = accumulator( -5.0 ) + 2.0 + > m = accumulator( 3.0 ) + 3.0 + > m = accumulator( 5.0 ) + 5.0 + > m = accumulator() + 5.0 + + See Also + -------- From 28d2308bdfd98905021a936bfc8233c99c282485 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 18 Jul 2026 13:08:58 -0500 Subject: [PATCH 09/11] fix: update copyright years --- lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js | 2 +- lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js | 2 +- lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js index 979c3c7e35bf..217b1b29b25a 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* Copyright (c) 2026 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. diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js index 0b2b207d29b7..6acaf711eeda 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 The Stdlib Authors. +* Copyright (c) 2026 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. diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js index 31323836330e..3ff30af129d3 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 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 f1a434a66ea0fe1e2daf9975c250dc1b50244b20 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 18 Jul 2026 22:45:17 -0500 Subject: [PATCH 10/11] fix: use format for benchmark description --- .../@stdlib/stats/incr/nanmmax/benchmark/benchmark.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js index b973541d08eb..6d22f0ea58e4 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/benchmark/benchmark.js @@ -22,6 +22,7 @@ var bench = require( '@stdlib/bench' ); var randu = require( '@stdlib/random/base/randu' ); +var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var incrnanmmax = require( './../lib' ); @@ -46,7 +47,7 @@ bench( pkg, function benchmark( b ) { b.end(); }); -bench( pkg+'::accumulator', function benchmark( b ) { +bench( format( '%s::accumulator', pkg ), function benchmark( b ) { var acc; var v; var i; From 25c0bce6ea9a13a28e12155c69045249001529ff Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 18 Jul 2026 23:29:33 -0500 Subject: [PATCH 11/11] fix: address review feedback --- .../@stdlib/stats/incr/nanmmax/docs/repl.txt | 2 + .../@stdlib/stats/incr/nanmmax/lib/index.js | 6 +-- .../@stdlib/stats/incr/nanmmax/lib/main.js | 2 - .../@stdlib/stats/incr/nanmmax/package.json | 10 ++-- .../@stdlib/stats/incr/nanmmax/test/test.js | 46 +++++++++++-------- 5 files changed, 40 insertions(+), 26 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt index 783b0fe71a9c..188b182ef050 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/docs/repl.txt @@ -1,3 +1,4 @@ + {{alias}}( W ) Returns an accumulator function which incrementally computes a moving maximum value, ignoring `NaN` values. @@ -43,3 +44,4 @@ See Also -------- + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js index 217b1b29b25a..da486a3c9b01 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/index.js @@ -19,14 +19,14 @@ 'use strict'; /** -* Compute a moving maximum incrementally, ignoring 'NaN' values. +* Compute a moving maximum incrementally, ignoring `NaN` values. * * @module @stdlib/stats/incr/nanmmax * * @example -* var incrmmax = require( '@stdlib/stats/incr/nanmmax' ); +* var incrnanmmax = require( '@stdlib/stats/incr/nanmmax' ); * -* var accumulator = incrmmax( 3 ); +* var accumulator = incrnanmmax( 3 ); * * var m = accumulator(); * // returns null diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js index 6acaf711eeda..c9ba37bff164 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/lib/main.js @@ -34,8 +34,6 @@ var incrmmax = require( '@stdlib/stats/incr/mmax' ); * @returns {Function} accumulator function * * @example -* var incrnanmmax = require( '@stdlib/stats/incr/nanmmax' ); -* * var accumulator = incrnanmmax( 3 ); * * var m = accumulator(); diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json b/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json index 270d5e27733e..48999e9f1d44 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/package.json @@ -57,12 +57,16 @@ "math", "maximum", "max", - "range", - "extremes", - "domain", + "extreme", "extent", + "range", "incremental", "accumulator", + "moving max", + "sliding window", + "sliding", + "window", + "moving", "nan", "ignore" ] diff --git a/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js index 3ff30af129d3..c3aec991e2bc 100644 --- a/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js +++ b/lib/node_modules/@stdlib/stats/incr/nanmmax/test/test.js @@ -24,7 +24,6 @@ var tape = require( 'tape' ); var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var incrmmax = require( '@stdlib/stats/incr/mmax' ); var incrnanmmax = require( './../lib' ); @@ -73,41 +72,52 @@ tape( 'the function throws an error if not provided a positive integer', functio function badValue( value ) { return function badValue() { - incrmmax( value ); + incrnanmmax( value ); }; } }); -tape( 'the accumulator function incrementally computes a maximum value', function test( t ) { +tape( 'the accumulator function computes a moving maximum incrementally, ignoring NaN values', function test( t ) { var expected; var actual; var data; var acc; - var max; var N; - var d; var i; - data = [ 2.0, 3.0, NaN, 1.0, 4.0, NaN, 3.0, 4.0 ]; + data = [ 5.0, NaN, 3.0, 2.0, NaN, 4.0, 1.0, NaN, 2.0, 1.0, 6.0, NaN, 2.0, 3.0 ]; N = data.length; - expected = []; + acc = incrnanmmax( 3 ); // Moving window of size 3 + actual = []; + for ( i = 0; i < N; i++ ) { + actual.push( acc( data[ i ] ) ); + } - acc = incrnanmmax( 3 ); + // Expected maximum values, ignoring NaN + expected = [ + 5.0, // [ 5.0 ] + 5.0, // [ 5.0 ] (NaN ignored) + 5.0, // [ 5.0, 3.0 ] + 5.0, // [ 5.0, 3.0, 2.0 ] + 5.0, // [ 5.0, 3.0, 2.0 ] (NaN ignored) + 4.0, // [ 3.0, 2.0, 4.0 ] (window moves) + 4.0, // [ 2.0, 4.0, 1.0 ] + 4.0, // [ 2.0, 4.0, 1.0 ] (NaN ignored) + 4.0, // [ 4.0, 1.0, 2.0 ] + 2.0, // [ 1.0, 2.0, 1.0 ] + 6.0, // [ 2.0, 1.0, 6.0 ] + 6.0, // [ 2.0, 1.0, 6.0 ] (NaN ignored) + 6.0, // [ 1.0, 6.0, 2.0 ] + 6.0 // [ 6.0, 2.0, 3.0 ] + ]; - max = data[ 0 ]; + // Check the computed values against the expected values for ( i = 0; i < N; i++ ) { - d = data[ i ]; - if ( isnan( d ) === false ) { - if ( max === null || d > max ) { - max = d; - } - } - expected.push( max ); - actual.push( acc( d ) ); + t.equal( actual[ i ], expected[ i ], 'returns expected value at index ' + i ); } - t.deepEqual( actual, expected, 'returns expected incremental results' ); + t.end(); });