feat: add stats/base/ndarray/smskmax

lib/node_modules/@stdlib/stats/base/ndarray/smskmax/README.md

@@ -0,0 +1,125 @@
+<!--
+
+@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.
+
+-->
+
+# smskmax
+
+> Calculate the maximum value of a single-precision floating-point ndarray according to a mask.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var smskmax = require( '@stdlib/stats/base/ndarray/smskmax' );
+```
+
+#### smskmax( arrays )
+
+Computes the maximum value of a single-precision floating-point ndarray according to a mask.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+var Uint8Array = require( '@stdlib/array/uint8' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+
+var xbuf = new Float32Array( [ 1.0, -2.0, 4.0, 2.0 ] );
+var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+
+var maskbuf = new Uint8Array( [ 0, 0, 1, 0 ] );
+var mask = new ndarray( 'uint8', maskbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+
+var v = smskmax( [ x, mask ] );
+// returns 2.0
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing an input ndarray and a mask ndarray.
+
+If a `mask` array element is `0`, the corresponding element in the input ndarray is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in the input ndarray is considered invalid/missing and **excluded** from computation.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty ndarray or a mask with all elements set to `1`, the function returns `NaN`.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var smskmax = require( '@stdlib/stats/base/ndarray/smskmax' );
+
+var xbuf = uniform( 10, -50.0, 50.0, {
+    'dtype': 'float32'
+});
+var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+console.log( ndarray2array( x ) );
+
+var maskbuf = bernoulli( xbuf.length, 0.2, {
+    'dtype': 'uint8'
+});
+var mask = new ndarray( 'uint8', maskbuf, [ maskbuf.length ], [ 1 ], 0, 'row-major' );
+console.log( ndarray2array( mask ) );
+
+var v = smskmax( [ 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">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ndarray/smskmax/benchmark/benchmark.js

@@ -0,0 +1,111 @@
+/**
+* @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/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var pkg = require( './../package.json' ).name;
+var smskmax = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var mask;
+	var mbuf;
+	var xbuf;
+	var x;
+
+	xbuf = uniform( len, -100.0, 100.0, options );
+	x = new ndarray( 'float32', xbuf, [ len ], [ 1 ], 0, 'row-major' );
+
+	mbuf = bernoulli( len, 0.2, {
+		'dtype': 'uint8'
+	});
+	mask = new ndarray( 'uint8', mbuf, [ len ], [ 1 ], 0, 'row-major' );
+
+	return benchmark;
+
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			xbuf[ i%len ] = i;
+			v = smskmax( [ x, mask ] );
+			if ( isnanf( v ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnanf( 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/base/ndarray/smskmax/docs/repl.txt

@@ -0,0 +1,36 @@
+
+{{alias}}( arrays )
+    Computes the maximum value of a single-precision floating-point one-
+    dimensional ndarray according to a mask.
+
+    If provided an empty ndarray or a mask with all elements set to `1`, the
+    function returns `NaN`.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing one single-precision floating-point
+        ndarray and one mask ndarray.
+
+    Returns
+    -------
+    out: number
+        Maximum value.
+
+    Examples
+    --------
+    > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 4.0, 2.0 ] );
+    > var dt = 'float32';
+    > var sh = [ xbuf.length ];
+    > var sx = [ 1 ];
+    > var ox = 0;
+    > var ord = 'row-major';
+    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+    > var mbuf = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 1, 0 ] );
+    > var mask = new {{alias:@stdlib/ndarray/ctor}}( 'uint8', mbuf, sh, sx, ox, ord );
+    > {{alias}}( [ x, mask ] )
+    2.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/stats/base/ndarray/smskmax/docs/types/index.d.ts

@@ -0,0 +1,50 @@
+/*
+* @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 { float32ndarray, uint8ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Computes the maximum value of a single-precision floating-point one-dimensional ndarray according to a mask.
+*
+* @param arrays - array-like object containing one single-precision floating-point ndarray and one mask ndarray
+* @returns maximum value
+*
+* @example
+* var Float32Array = require( '@stdlib/array/float32' );
+* var Uint8Array = require( '@stdlib/array/uint8' );
+* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+*
+* var xbuf = new Float32Array( [ 1.0, -2.0, 4.0, 2.0 ] );
+* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+*
+* var mbuf = new Uint8Array( [ 0, 0, 1, 0 ] );
+* var mask = new ndarray( 'uint8', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+*
+* var v = smskmax( [ x, mask ] );
+* // returns 2.0
+*/
+declare function smskmax( arrays: [ float32ndarray, uint8ndarray ] ): number;
+
+
+// EXPORTS //
+
+export = smskmax;

lib/node_modules/@stdlib/stats/base/ndarray/smskmax/docs/types/test.ts

@@ -0,0 +1,63 @@
+/*
+* @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.
+*/
+
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import smskmax = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'float32'
+	});
+	const mask = zeros( [ 10 ], {
+		'dtype': 'uint8'
+	});
+
+	smskmax( [ x, mask ] ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+	smskmax( '10' ); // $ExpectError
+	smskmax( 10 ); // $ExpectError
+	smskmax( true ); // $ExpectError
+	smskmax( false ); // $ExpectError
+	smskmax( null ); // $ExpectError
+	smskmax( undefined ); // $ExpectError
+	smskmax( [] ); // $ExpectError
+	smskmax( {} ); // $ExpectError
+	smskmax( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'float32'
+	});
+	const mask = zeros( [ 10 ], {
+		'dtype': 'uint8'
+	});
+
+	smskmax(); // $ExpectError
+	smskmax( [ x, mask ], {} ); // $ExpectError
+}