diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/README.md b/lib/node_modules/@stdlib/stats/incr/nanmin/README.md new file mode 100644 index 000000000000..c3cf6eee6bfa --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/README.md @@ -0,0 +1,129 @@ + + +# incrnanmin + +> Compute a minimum value incrementally, ignoring `NaN` values. + +
+ +## Usage + +```javascript +var incrnanmin = require( '@stdlib/stats/incr/nanmin' ); +``` + +#### incrnanmin() + +Returns an accumulator `function` which incrementally computes a minimum value, ignoring `NaN` values. + +```javascript +var accumulator = incrnanmin(); +``` + +#### accumulator( \[x] ) + +If provided an input value `x`, the accumulator function returns an updated minimum value. If not provided an input value `x`, the accumulator function returns the current minimum value. + +```javascript +var accumulator = incrnanmin(); + +var min = accumulator( 2.0 ); +// returns 2.0 + +min = accumulator( 1.0 ); +// returns 1.0 + +min = accumulator( NaN ); +// returns 1.0 + +min = accumulator( 3.0 ); +// returns 1.0 + +min = accumulator(); +// returns 1.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. +- If all provided values are `NaN`, the accumulator returns `null`. + +
+ + + +
+ +## Examples + +```javascript +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var incrnanmin = require( '@stdlib/stats/incr/nanmin' ); + +var accumulator; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanmin(); + +// For each simulated datum, update the min... +for ( i = 0; i < 100; i++ ) { + if ( bernoulli( 0.2 ) ) { + v = NaN; + } else { + v = uniform( 0.0, 100.0 ); + } + accumulator( v ); +} +console.log( accumulator() ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ + + + + +
+ + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmin/benchmark/benchmark.js new file mode 100644 index 000000000000..1f67602e89d4 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/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 incrnanmin = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanmin(); + 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 = incrnanmin(); + + 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/nanmin/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmin/docs/repl.txt new file mode 100644 index 000000000000..4a0564d110f1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/docs/repl.txt @@ -0,0 +1,37 @@ +{{alias}}() + Returns an accumulator function which incrementally computes a minimum + value, ignoring NaN values. + + If provided a value, the accumulator function returns an updated minimum + value. If not provided a value, the accumulator function returns the current + minimum value. + + If no valid numbers have been provided (only NaN values), the accumulator + function returns null. Unlike incrmin, NaN values are ignored and do not + set the minimum to NaN. + + Returns + ------- + acc: Function + Accumulator function. + + Examples + -------- + > var accumulator = {{alias}}(); + > var m = accumulator() + null + > m = accumulator( 3.14 ) + 3.14 + > m = accumulator( NaN ) + 3.14 + > m = accumulator( -5.0 ) + -5.0 + > m = accumulator( 10.1 ) + -5.0 + > m = accumulator( NaN ) + -5.0 + > m = accumulator() + -5.0 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmin/docs/types/index.d.ts new file mode 100644 index 000000000000..49acc87a00e9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/docs/types/index.d.ts @@ -0,0 +1,65 @@ +/* +* @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 minimum value; otherwise, returns the current minimum value. +* +* @param x - value +* @returns minimum value +*/ +type accumulator = ( x?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes a minimum value, ignoring `NaN` values. +* +* @returns accumulator function +* +* @example +* var accumulator = incrnanmin(); +* +* var m = accumulator(); +* // returns null +* +* m = accumulator( 3.14 ); +* // returns 3.14 +* +* m = accumulator( NaN ); +* // returns 3.14 +* +* m = accumulator( -5.0 ); +* // returns -5.0 +* +* m = accumulator( 10.1 ); +* // returns -5.0 +* +* m = accumulator( NaN ); +* // returns -5.0 +* +* m = accumulator(); +* // returns -5.0 +*/ +declare function incrnanmin(): accumulator; + + +// EXPORTS // + +export = incrnanmin; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmin/docs/types/test.ts new file mode 100644 index 000000000000..004af50a8865 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/docs/types/test.ts @@ -0,0 +1,61 @@ +/* +* @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 incrnanmin = require('./index') + + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanmin(); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided arguments... +{ + incrnanmin( '5' ); // $ExpectError + incrnanmin( 5 ); // $ExpectError + incrnanmin( true ); // $ExpectError + incrnanmin( false ); // $ExpectError + incrnanmin( null ); // $ExpectError + incrnanmin( undefined ); // $ExpectError + incrnanmin( [] ); // $ExpectError + incrnanmin( {} ); // $ExpectError + incrnanmin( ( x: number ): number => x ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanmin(); + + 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 = incrnanmin(); + + 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/nanmin/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmin/examples/index.js new file mode 100644 index 000000000000..a632ea95ccf7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/examples/index.js @@ -0,0 +1,38 @@ +/** +* @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 bernoulli = require( '@stdlib/random/base/bernoulli' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var incrnanmin = require( './../lib' ); + +// Initialize an accumulator: +var accumulator = incrnanmin(); + +// For each simulated datum, update the min... +console.log( '\nValue\tMin\n' ); +var min; +var v; +var i; +for ( i = 0; i < 100; i++ ) { + v = ( bernoulli( 0.2 ) ) ? NaN : uniform( 0.0, 100.0 ); + min = accumulator( v ); + console.log( '%s\t%s', ( v === v ) ? v.toFixed( 4 ) : 'NaN', ( min === null ) ? 'null' : min.toFixed( 4 ) ); +} +console.log( '\nFinal min: %d\n', accumulator() ); diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmin/lib/index.js new file mode 100644 index 000000000000..896f9b9917dc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/lib/index.js @@ -0,0 +1,57 @@ +/** +* @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 minimum value incrementally, ignoring `NaN` values. +* +* @module @stdlib/stats/incr/nanmin +* +* @example +* var incrnanmin = require( '@stdlib/stats/incr/nanmin' ); +* +* var accumulator = incrnanmin(); +* +* var min = accumulator(); +* // returns null +* +* min = accumulator( 3.14 ); +* // returns 3.14 +* +* min = accumulator( -5.0 ); +* // returns -5.0 +* +* min = accumulator( NaN ); +* // returns -5.0 +* +* min = accumulator( 10.1 ); +* // returns -5.0 +* +* min = accumulator(); +* // returns -5.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmin/lib/main.js new file mode 100644 index 000000000000..b0a2aa6f44d1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/lib/main.js @@ -0,0 +1,77 @@ +/** +* @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 incrmin = require( '@stdlib/stats/incr/min' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes a minimum value, ignoring `NaN` values. +* +* @returns {Function} accumulator function +* +* @example +* var accumulator = incrnanmin(); +* +* var min = accumulator(); +* // returns null +* +* min = accumulator( 3.14 ); +* // returns 3.14 +* +* min = accumulator( -5.0 ); +* // returns -5.0 +* +* min = accumulator( NaN ); +* // returns -5.0 +* +* min = accumulator( 10.1 ); +* // returns -5.0 +* +* min = accumulator(); +* // returns -5.0 +*/ +function incrnanmin() { + var min = incrmin(); + return accumulator; + + /** + * If provided a value, the accumulator function returns an updated minimum value. If not provided a value, the accumulator function returns the current minimum value. + * + * @private + * @param {number} [x] - new value + * @returns {(number|null)} min value or null + */ + function accumulator( x ) { + if ( arguments.length === 0 || isnan( x ) ) { + return min(); + } + return min( x ); + } +} + + +// EXPORTS // + +module.exports = incrnanmin; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/package.json b/lib/node_modules/@stdlib/stats/incr/nanmin/package.json new file mode 100644 index 000000000000..b68751e3f7b1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/stats/incr/nanmin", + "version": "0.0.0", + "description": "Compute a minimum value 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", + "minimum", + "min", + "range", + "extremes", + "domain", + "extent", + "incremental", + "accumulator", + "nan", + "ignore" + ] +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmin/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmin/test/test.js new file mode 100644 index 000000000000..1afc4102fb11 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmin/test/test.js @@ -0,0 +1,126 @@ +/** +* @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 incrnanmin = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanmin, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.equal( typeof incrnanmin(), 'function', 'returns a function' ); + t.end(); +}); + +tape( 'if not provided any values, the initial returned minimum value is `null`', function test( t ) { + var acc = incrnanmin(); + t.equal( acc(), null, 'returns null' ); + t.end(); +}); + +tape( 'the accumulator function incrementally computes a minimum value', function test( t ) { + var expected; + var actual; + var data; + var acc; + var min; + 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 = incrnanmin(); + + min = data[ 0 ]; + for ( i = 0; i < N; i++ ) { + d = data[ i ]; + if ( isnan( d ) === false ) { + if ( min === null || d < min ) { + min = d; + } + } + expected.push( min ); + 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 minimum value', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, NaN, 1.0, NaN, 3.0 ]; + acc = incrnanmin(); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( acc(), 1.0, 'returns the current accumulated minimum value' ); + t.end(); +}); + +tape( 'the accumulator function correctly handles signed zeros', function test( t ) { + var acc; + var v; + + acc = incrnanmin(); + + v = acc( 0.0 ); + t.equal( isPositiveZero( v ), true, 'returns expected value' ); + + v = acc( -0.0 ); + t.equal( isNegativeZero( v ), true, 'returns expected value' ); + + v = acc( 0.0 ); + t.equal( isNegativeZero( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `NaN`, the accumulator function ignores it and maintains the current minimum', 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 = incrnanmin(); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.equal( isnan( acc() ), false, 'returns expected value' ); + t.end(); +});