feat: add stats/incr/nanmin

PR-URL: stdlib-js#5917
Closes: stdlib-js#5551

Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

Author: abhishekblue

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

@@ -0,0 +1,129 @@
+<!--
+
+@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.
+
+-->
+
+# incrnanmin
+
+> Compute a minimum value incrementally, ignoring `NaN` values.
+
+<section class="usage">
+
+## 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
+```
+
+</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.
+-   If all provided values are `NaN`, the accumulator returns `null`.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## 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() );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</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> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

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();
+});

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
+    --------

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
+
+/// <reference types="@stdlib/types"/>
+
+/**
+* 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;

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
+}