feat: add stats/array/nanmskmax

lib/node_modules/@stdlib/stats/array/nanmskmax/README.md

@@ -0,0 +1,120 @@
+<!--
+
+@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.
+
+-->
+
+# nanmskmax
+
+> Calculate the maximum value of an array according to a mask, ignoring `NaN` values.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var nanmskmax = require( '@stdlib/stats/array/nanmskmax' );
+```
+
+#### nanmskmax( x, mask )
+
+Computes the maximum value of an array according to a mask, ignoring `NaN` values.
+
+```javascript
+var x = [ 1.0, -2.0, NaN, 2.0 ];
+var mask = [ 0, 1, 0, 0 ];
+
+var v = nanmskmax( x, mask );
+// returns 2.0
+```
+
+The function has the following parameters:
+
+-   **x**: input array.
+-   **mask**: mask array. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from computation.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty array, the function returns `NaN`.
+-   The function supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var nanmskmax = require( '@stdlib/stats/array/nanmskmax' );
+
+function rand() {
+    if ( bernoulli( 0.8 ) < 1 ) {
+        return NaN;
+    }
+    return uniform( -50.0, 50.0 );
+}
+
+var x = filledarrayBy( 10, 'float64', rand );
+console.log( x );
+
+var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) );
+console.log( mask );
+
+var v = nanmskmax( x, mask );
+console.log( v );
+```
+
+</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">
+
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/array/nanmskmax/benchmark/benchmark.js

@@ -0,0 +1,108 @@
+/**
+* @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 uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var pkg = require( './../package.json' ).name;
+var nanmskmax = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Returns a random value or `NaN`.
+*
+* @private
+* @returns {number} random number or `NaN`
+*/
+function rand() {
+	if ( bernoulli( 0.8 ) < 1 ) {
+		return NaN;
+	}
+	return uniform( -10.0, 10.0 );
+}
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var mask;
+	var x;
+
+	x = filledarrayBy( len, 'generic', rand );
+	mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) );
+	return benchmark;
+
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = nanmskmax( x, mask );
+			if ( isnan( v ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( v ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/stats/array/nanmskmax/docs/repl.txt

@@ -0,0 +1,36 @@
+
+{{alias}}( x, mask )
+    Computes the maximum value of an array according to a mask, ignoring `NaN`
+    values.
+
+    If a `mask` array element is `0`, the corresponding element in `x` is
+    considered valid and included in computation.
+
+    If a `mask` array element is `1`, the corresponding element in `x` is
+    considered invalid/missing and excluded from computation.
+
+    If provided an empty array, the function returns `NaN`.
+
+    Parameters
+    ----------
+    x: Array<number>|TypedArray
+        Input array.
+
+    mask: Array<number>|TypedArray
+        Mask array.
+
+    Returns
+    -------
+    out: number
+        Maximum value.
+
+    Examples
+    --------
+    > var x = [ 1.0, -2.0, NaN, 2.0 ];
+    > var mask = [ 0, 1, 0, 0 ];
+    > {{alias}}( x, mask )
+    2.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/array/nanmskmax/docs/types/index.d.ts

@@ -0,0 +1,49 @@
+/*
+* @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 { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
+
+/**
+* Computes the maximum value of an array according to a mask, ignoring `NaN` values.
+*
+* @param x - input array
+* @param mask - mask array
+* @returns maximum value
+*
+* @example
+* var x = [ 1.0, -2.0, NaN, 2.0 ];
+* var mask = [ 0, 1, 0, 0 ];
+*
+* var v = nanmskmax( x, mask );
+* // returns 2.0
+*/
+declare function nanmskmax( x: InputArray, mask: InputArray ): number;
+
+
+// EXPORTS //
+
+export = nanmskmax;

lib/node_modules/@stdlib/stats/array/nanmskmax/docs/types/test.ts

@@ -0,0 +1,70 @@
+/*
+* @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 AccessorArray = require( '@stdlib/array/base/accessor' );
+import nanmskmax = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	const x = new Float64Array( 10 );
+	const mask = new Uint8Array( 10 );
+
+	nanmskmax( x, mask ); // $ExpectType number
+	nanmskmax( new AccessorArray( x ), mask ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a numeric array...
+{
+	const mask = new Uint8Array( 10 );
+
+	nanmskmax( 10, mask ); // $ExpectError
+	nanmskmax( '10', mask ); // $ExpectError
+	nanmskmax( true, mask ); // $ExpectError
+	nanmskmax( false, mask ); // $ExpectError
+	nanmskmax( null, mask ); // $ExpectError
+	nanmskmax( undefined, mask ); // $ExpectError
+	nanmskmax( {}, mask ); // $ExpectError
+	nanmskmax( ( x: number ): number => x, mask ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a numeric array...
+{
+	const x = new Float64Array( 10 );
+
+	nanmskmax( x, 10 ); // $ExpectError
+	nanmskmax( x, '10' ); // $ExpectError
+	nanmskmax( x, true ); // $ExpectError
+	nanmskmax( x, false ); // $ExpectError
+	nanmskmax( x, null ); // $ExpectError
+	nanmskmax( x, undefined ); // $ExpectError
+	nanmskmax( x, {} ); // $ExpectError
+	nanmskmax( x, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = new Float64Array( 10 );
+	const mask = new Uint8Array( 10 );
+
+	nanmskmax(); // $ExpectError
+	nanmskmax( x, {} ); // $ExpectError
+	nanmskmax( x, mask, {} ); // $ExpectError
+}