feat: refactor and add protocol support to stats/base/nanmskmin #5663

lib/node_modules/@stdlib/stats/base/nanmskmin/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2020 The Stdlib Authors.
+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.
@@ -33,90 +33,52 @@ limitations under the License.
 ## Usage
 
 ```javascript
-var nanmskmin = require( '@stdlib/stats/base/nanmskmin' );
+var nanmskmin = require("@stdlib/stats/base/nanmskmin");
 ```
 
 #### nanmskmin( N, x, strideX, mask, strideMask )
 
 Computes the minimum value of a strided array `x` according to a `mask`, ignoring `NaN` values.
 
 ```javascript
-var x = [ 1.0, -2.0, -4.0, 2.0, NaN ];
-var mask = [ 0, 0, 1, 0, 0 ];
+var x = [1.0, -2.0, -4.0, 2.0, NaN];
+var mask = [0, 0, 1, 0, 0];
 
-var v = nanmskmin( x.length, x, 1, mask, 1 );
+var v = nanmskmin(x.length, x, 1, mask, 1);
 // returns -2.0
 ```
 
 The function has the following parameters:
 
--   **N**: number of indexed elements.
--   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
--   **strideX**: index increment for `x`.
--   **mask**: mask [`Array`][mdn-array] or [`typed array`][mdn-typed-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.
--   **strideMask**: index increment for `mask`.
+- **N**: number of indexed elements.
+- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
+- **strideX**: stride length for `x`.
+- **mask**: mask [`Array`][mdn-array] or [`typed array`][mdn-typed-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.
+- **strideMask**: stride length for `mask`.
 
-The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
+The `N` and `stride` parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
 
 ```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
+var x = [1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0];
+var mask = [0, 0, 0, 0, 0, 0, 1, 1];
 
-var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0 ];
-var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ];
-var N = floor( x.length / 2 );
-
-var v = nanmskmin( N, x, 2, mask, 2 );
+var v = nanmskmin(4, x, 2, mask, 2);
 // returns -7.0
 ```
 
 Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views.
 
-<!-- eslint-disable stdlib/capitalized-comments -->
-
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var Uint8Array = require( '@stdlib/array/uint8' );
-var floor = require( '@stdlib/math/base/special/floor' );
+var Float64Array = require("@stdlib/array/float64");
+var Uint8Array = require("@stdlib/array/uint8");
 
-var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] );
-var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var x0 = new Float64Array([2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0]);
+var x1 = new Float64Array(x0.buffer, x0.BYTES_PER_ELEMENT * 1);
 
-var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] );
-var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var mask0 = new Uint8Array([0, 0, 0, 0, 0, 0, 1, 1]);
+var mask1 = new Uint8Array(mask0.buffer, mask0.BYTES_PER_ELEMENT * 1);
 
-var N = floor( x0.length / 2 );
-
-var v = nanmskmin( N, x1, 2, mask1, 2 );
-// returns -2.0
-```
-
-#### nanmskmin.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )
-
-Computes the minimum value of a strided array according to a `mask`, ignoring `NaN` values and using alternative indexing semantics.
-
-```javascript
-var x = [ 1.0, -2.0, -4.0, 2.0, NaN ];
-var mask = [ 0, 0, 1, 0, 0 ];
-
-var v = nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 );
-// returns -2.0
-```
-
-The function has the following additional parameters:
-
--   **offsetX**: starting index for `x`.
--   **offsetMask**: starting index for `mask`.
-
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum value for every other value in `x` starting from the second value
-
-```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
-
-var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0 ];
-var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ];
-var N = floor( x.length / 2 );
-
-var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
+var v = nanmskmin(4, x1, 2, mask1, 2);
 // returns -2.0
 ```
 
@@ -128,8 +90,9 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
 
 ## Notes
 
--   If `N <= 0`, both functions return `NaN`.
--   Depending on the environment, the typed versions ([`dnanmskmin`][@stdlib/stats/base/dnanmskmin], [`snanmskmin`][@stdlib/stats/base/snanmskmin], etc.) are likely to be significantly more performant.
+- If `N <= 0`, both functions return `NaN`.
+- Depending on the environment, the typed versions ([`dnanmskmin`][@stdlib/stats/base/dnanmskmin], [`snanmskmin`][@stdlib/stats/base/snanmskmin], etc.) are likely to be significantly more performant.
+- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
 
 </section>
 
@@ -139,84 +102,57 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 );
 
 ## Examples
 
-<!-- eslint no-undef: "error" -->
-
 ```javascript
-var randu = require( '@stdlib/random/base/randu' );
-var round = require( '@stdlib/math/base/special/round' );
-var Float64Array = require( '@stdlib/array/float64' );
-var Uint8Array = require( '@stdlib/array/uint8' );
-var nanmskmin = require( '@stdlib/stats/base/nanmskmin' );
-
-var mask;
-var x;
-var i;
-
-x = new Float64Array( 10 );
-mask = new Uint8Array( x.length );
-for ( i = 0; i < x.length; i++ ) {
-    if ( randu() < 0.2 ) {
-        mask[ i ] = 1;
-    } else {
-        mask[ i ] = 0;
-    }
-    if ( randu() < 0.1 ) {
-        x[ i ] = NaN;
-    } else {
-        x[ i ] = round( (randu()*100.0) - 50.0 );
-    }
-}
-console.log( x );
-console.log( mask );
-
-var v = nanmskmin( x.length, x, 1, mask, 1 );
-console.log( v );
+var uniform = require("@stdlib/random/array/uniform");
+var bernoulli = require("@stdlib/random/array/bernoulli");
+var nanmskmin = require("@stdlib/stats/base/nanmskmin");
+
+var x = uniform(10, -50.0, 50.0, {
+    dtype: "float64",
+});
+console.log(x);
+
+var mask = bernoulli(x.length, 0.2, {
+    dtype: "uint8",
+});
+console.log(mask);
+
+var v = nanmskmin(x.length, x, 1, mask, 1);
+console.log(v);
 ```
 
 </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/base/dnanmskmin`][@stdlib/stats/base/dnanmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a double-precision floating-point strided array according to a mask, ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats/base/mskmin`][@stdlib/stats/base/mskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a strided array according to a mask.</span>
--   <span class="package-name">[`@stdlib/stats/base/nanmin`][@stdlib/stats/base/nanmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a strided array, ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats/base/nanmskmax`][@stdlib/stats/base/nanmskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a strided array according to a mask, ignoring NaN values.</span>
--   <span class="package-name">[`@stdlib/stats/base/snanmskmin`][@stdlib/stats/base/snanmskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring NaN values.</span>
+- [`@stdlib/stats/base/dnanmskmin`][@stdlib/stats/base/dnanmskmin]
+- [`@stdlib/stats/base/mskmin`][@stdlib/stats/base/mskmin]
+- [`@stdlib/stats/base/nanmin`][@stdlib/stats/base/nanmin]
+- [`@stdlib/stats/base/nanmskmax`][@stdlib/stats/base/nanmskmax]
+- [`@stdlib/stats/base/snanmskmin`][@stdlib/stats/base/snanmskmin]
 
 </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">
 
 [mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
-
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
-<!-- <related-links> -->
-
 [@stdlib/stats/base/dnanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmskmin
-
 [@stdlib/stats/base/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/mskmin
-
 [@stdlib/stats/base/nanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmin
-
 [@stdlib/stats/base/nanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmskmax
-
 [@stdlib/stats/base/snanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanmskmin
 
-<!-- </related-links> -->
-
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* 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.
@@ -21,13 +21,21 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
 var nanmskmin = require( './../lib/nanmskmin.js' );
 
 
+// VARIABLES //
+
+ var options = {
+ 	'dtype': 'generic'
+ };
+
+
 // FUNCTIONS //
 
 /**
@@ -38,20 +46,8 @@ var nanmskmin = require( './../lib/nanmskmin.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var mask;
-	var x;
-	var i;
-
-	x = [];
-	mask = [];
-	for ( i = 0; i < len; i++ ) {
-		if ( randu() < 0.2 ) {
-			mask.push( 1 );
-		} else {
-			mask.push( 0 );
-		}
-		x.push( ( randu()*20.0 ) - 10.0 );
-	}
+	var mask = bernoulli( len, 0.2, options );
+ 	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {

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

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* 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.
@@ -21,13 +21,21 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
 var nanmskmin = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,20 +46,8 @@ var nanmskmin = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var mask;
-	var x;
-	var i;
-
-	x = [];
-	mask = [];
-	for ( i = 0; i < len; i++ ) {
-		if ( randu() < 0.2 ) {
-			mask.push( 1 );
-		} else {
-			mask.push( 0 );
-		}
-		x.push( ( randu()*20.0 ) - 10.0 );
-	}
+	var mask = bernoulli( len, 0.2, options );
+ 	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {