feat: add nanminmax package to handle NaN values

Author: abhishekblue

lib/node_modules/@stdlib/stats/incr/nanminmax/README.md

@@ -0,0 +1,157 @@
+<!--
+
+@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.
+
+-->
+
+# incrnanminmax
+
+> Compute a minimum and maximum incrementally, ignoring `NaN` values.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var incrnanminmax = require( '@stdlib/stats/incr/nanminmax' );
+```
+
+#### incrnanminmax( \[out] )
+
+Returns an accumulator `function` which incrementally computes a minimum and maximum, ignoring `NaN` values.
+
+```javascript
+var accumulator = incrnanminmax();
+```
+
+By default, the returned accumulator `function` returns the minimum and maximum as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
+
+
+#### accumulator( \[x] )
+
+If provided an input value `x`, the accumulator function returns updated minimum and maximum values. If not provided an input value `x`, the accumulator function returns the current minimum and maximum values.
+
+```javascript
+var accumulator = incrnanminmax();
+
+var mm = accumulator();
+// returns null
+
+mm = accumulator( 2.0 );
+// returns [ 2.0, 2.0 ]
+
+mm = accumulator( 1.0 );
+// returns [ 1.0, 2.0 ]
+
+mm = accumulator( 3.0 );
+// returns [ 1.0, 3.0 ]
+
+mm = accumulator( -7.0 );
+// returns [ -7.0, 3.0 ]
+
+mm = accumulator( NaN );
+// returns [ -7.0, 3.0 ]
+
+mm = accumulator( -5.0 );
+// returns [ -7.0, 3.0 ]
+
+mm = accumulator();
+// returns [ -7.0, 3.0 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## 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.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var incrnanminmax = require( './../lib' );
+
+var accumulator;
+var v;
+var i;
+
+// Initialize an accumulator:
+accumulator = incrnanminmax();
+
+// For each simulated datum, update the minimum and maximum...
+for ( i = 0; i < 100; i++ ) {
+	if ( randu() < 0.2 ) {
+		v = NaN;
+	} else {
+		v = randu() * 100.0;
+	}
+}
+console.log( accumulator() );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/stats/incr/max`][@stdlib/stats/incr/max]</span><span class="delimiter">: </span><span class="description">compute a maximum value incrementally.</span>
+-   <span class="package-name">[`@stdlib/stats/incr/min`][@stdlib/stats/incr/min]</span><span class="delimiter">: </span><span class="description">compute a minimum value incrementally.</span>
+-   <span class="package-name">[`@stdlib/stats/incr/mminmax`][@stdlib/stats/incr/mminmax]</span><span class="delimiter">: </span><span class="description">compute a moving minimum and maximum incrementally.</span>
+-   <span class="package-name">[`@stdlib/stats/incr/range`][@stdlib/stats/incr/range]</span><span class="delimiter">: </span><span class="description">compute a range incrementally.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+<!-- <related-links> -->
+
+[@stdlib/stats/incr/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/max
+
+[@stdlib/stats/incr/min]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/min
+
+[@stdlib/stats/incr/mminmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mminmax
+
+[@stdlib/stats/incr/range]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/range
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/incr/nanminmax/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 incrnanminmax = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var f;
+	var i;
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		f = incrnanminmax();
+		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 = incrnanminmax();
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = acc( randu() );
+		if ( v.length !== 2 ) {
+			b.fail( 'should contain two elements' );
+		}
+	}
+	b.toc();
+	if ( v[ 0 ] !== v[ 0 ] || v[ 1 ] !== v[ 1 ] ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/stats/incr/nanminmax/docs/repl.txt

@@ -0,0 +1,40 @@
+
+{{alias}}( [out] )
+    Returns an accumulator function which incrementally computes a minimum and
+    maximum, ignoring `NaN` values.
+
+    If provided a value, the accumulator function returns an updated minimum and
+    maximum. If not provided a value, the accumulator function returns the
+    current minimum and maximum.
+
+    Parameters
+    ----------
+    out: Array|TypedArray (optional)
+        Output array.
+
+    Returns
+    -------
+    acc: Function
+        Accumulator function.
+
+    Examples
+    --------
+    > var accumulator = {{alias}}();
+    > var mm = accumulator()
+    null
+    > mm = accumulator( 2.0 )
+    [ 2.0, 2.0 ]
+    > mm = accumulator( -5.0 )
+    [ -5.0, 2.0 ]
+    > mm = accumulator( 3.0 )
+    [ -5.0, 3.0 ]
+    > mm = accumulator( NaN )
+    [ -5.0, 3.0 ]
+    > mm = accumulator( 5.0 )
+    [ -5.0, 5.0 ]
+    > mm = accumulator()
+    [ -5.0, 5.0 ]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/incr/nanminmax/docs/types/index.d.ts

@@ -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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { ArrayLike } from '@stdlib/types/array';
+
+/**
+* If provided a value, the accumulator function returns updated minimum and maximum values. If not provided a value, the accumulator function returns the current minimum and maximum values.
+*
+* @param x - input value
+* @returns output array or null
+*/
+type accumulator = ( x?: number ) => ArrayLike<number> | null;
+
+/**
+* Returns an accumulator function which incrementally computes minimum and maximum values.
+*
+* @param out - output array
+* @returns accumulator function
+*
+* @example
+* var accumulator = incrminmax();
+*
+* var mm = accumulator();
+* // returns null
+*
+* mm = accumulator( 2.0 );
+* // returns [ 2.0, 2.0 ]
+*
+* mm = accumulator( -5.0 );
+* // returns [ -5.0, 2.0 ]
+*
+* mm = accumulator( 3.0 );
+* // returns [ -5.0, 3.0 ]
+*
+* mm = accumulator( NaN );
+* // returns [ -5.0, 3.0 ]
+*
+* mm = accumulator( 5.0 );
+* // returns [ -5.0, 5.0 ]
+*
+* mm = accumulator();
+* // returns [ -5.0, 5.0 ]
+*/
+declare function incrnanminmax( out?: ArrayLike<number> ): accumulator;
+
+
+// EXPORTS //
+
+export = incrnanminmax;

lib/node_modules/@stdlib/stats/incr/nanminmax/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 incrnanminmax = require( './index' );
+
+
+// TESTS //
+
+// The function returns an accumulator function...
+{
+	incrnanminmax(); // $ExpectType accumulator
+	const out = [ 0.0, 0.0 ];
+	incrnanminmax( out ); // $ExpectType accumulator
+}
+
+// The compiler throws an error if the function is provided an argument that is not an array-like object of numbers...
+{
+	incrnanminmax( '5' ); // $ExpectError
+	incrnanminmax( 5 ); // $ExpectError
+	incrnanminmax( true ); // $ExpectError
+	incrnanminmax( false ); // $ExpectError
+	incrnanminmax( null ); // $ExpectError
+	incrnanminmax( {} ); // $ExpectError
+	incrnanminmax( ( x: number ): number => x ); // $ExpectError
+}
+
+// The function returns an accumulator function which returns an accumulated result...
+{
+	const acc = incrnanminmax();
+
+	acc(); // $ExpectType ArrayLike<number> | null
+	acc( 3.14 ); // $ExpectType ArrayLike<number> | null
+}
+
+// The compiler throws an error if the returned accumulator function is provided invalid arguments...
+{
+	const acc = incrnanminmax();
+
+	acc( '5' ); // $ExpectError
+	acc( true ); // $ExpectError
+	acc( false ); // $ExpectError
+	acc( null ); // $ExpectError
+	acc( [] ); // $ExpectError
+	acc( {} ); // $ExpectError
+	acc( ( x: number ): number => x ); // $ExpectError
+}