feat: refactor and add protocol support to stats/base/nanmax-by

PR-URL: #6469
Closes: #5653
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Co-authored-by: stdlib-bot <[email protected]>
Co-authored-by: Gururaj Gurram <[email protected]>

Author: 4 people

lib/node_modules/@stdlib/stats/base/nanmax-by/README.md

@@ -30,9 +30,9 @@ limitations under the License.
 var nanmaxBy = require( '@stdlib/stats/base/nanmax-by' );
 ```
 
-#### nanmaxBy( N, x, stride, clbk\[, thisArg] )
+#### nanmaxBy( N, x, strideX, clbk\[, thisArg] )
 
-Calculates the maximum value of strided array `x` via a callback function, ignoring `NaN` values.
+Computes the maximum value of a strided array via a callback function, ignoring `NaN` values.
 
 ```javascript
 function accessor( v ) {
@@ -49,7 +49,7 @@ The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **x**: input [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions).
--   **stride**: index increment.
+-   **strideX**: stride length.
 -   **clbk**: callback function.
 -   **thisArg**: execution context (_optional_).
 
@@ -81,27 +81,23 @@ var cnt = context.count;
 // returns 10
 ```
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to access every other element
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element
 
 ```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
-
 function accessor( v ) {
     return v * 2.0;
 }
 
 var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0, NaN, NaN ];
-var N = floor( x.length / 2 );
 
-var v = nanmaxBy( N, x, 2, accessor );
+var v = nanmaxBy( 5, x, 2, accessor );
 // returns 8.0
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 function accessor( v ) {
     return v * 2.0;
@@ -112,16 +108,15 @@ var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
 
 // Create an offset view...
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
-var N = floor( x0.length/2 );
 
 // Access every other element...
-var v = nanmaxBy( N, x1, 2, accessor );
+var v = nanmaxBy( 3, x1, 2, accessor );
 // returns -4.0
 ```
 
-#### nanmaxBy.ndarray( N, x, stride, offset, clbk\[, thisArg] )
+#### nanmaxBy.ndarray( N, x, strideX, offsetX, clbk\[, thisArg] )
 
-Calculates the maximum value of strided array `x` via a callback function, ignoring `NaN` values and using alternative indexing semantics.
+Computes the maximum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics.
 
 ```javascript
 function accessor( v ) {
@@ -136,9 +131,9 @@ var v = nanmaxBy.ndarray( x.length, x, 1, 0, accessor );
 
 The function has the following additional parameters:
 
--   **offset**: starting index.
+-   **offsetX**: starting index.
 
-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 access only the last three elements of `x`
+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 access only the last three elements of `x`
 
 ```javascript
 function accessor( v ) {
@@ -164,6 +159,7 @@ var v = nanmaxBy.ndarray( 3, x, 1, x.length-3, accessor );
 -   If a provided callback function returns `NaN`, the value is ignored.
 -   If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored.
 -   When possible, prefer using [`dnanmax`][@stdlib/stats/strided/dnanmax], [`snanmax`][@stdlib/stats/strided/snanmax], and/or [`nanmax`][@stdlib/stats/base/nanmax], as, depending on the environment, these interfaces 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>
 
@@ -176,23 +172,23 @@ var v = nanmaxBy.ndarray( 3, x, 1, x.length-3, accessor );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
 var filledarrayBy = require( '@stdlib/array/filled-by' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
 var nanmaxBy = require( '@stdlib/stats/base/nanmax-by' );
 
-function fill() {
-    if ( randu() < 0.2 ) {
+function rand() {
+    if ( bernoulli( 0.8 )< 0.2 ) {
         return NaN;
     }
-    return discreteUniform( -50, 50 );
+    return uniform( -50, 50 );
 }
 
 function accessor( v ) {
     return v * 2.0;
 }
 
-var x = filledarrayBy( 10, 'float64', fill );
+var x = filledarrayBy( 10, 'float64', rand );
 console.log( x );
 
 var v = nanmaxBy( x.length, x, 1, accessor );
@@ -229,6 +225,8 @@ console.log( v );
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
 <!-- <related-links> -->
 
 [@stdlib/stats/strided/dnanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmax

lib/node_modules/@stdlib/stats/base/nanmax-by/benchmark/benchmark.js

@@ -21,11 +21,13 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
-var nanmaxBy = require( './../lib/nanmax_by.js' );
+var nanmaxBy = require( './../lib/main.js' );
 
 
 // FUNCTIONS //
@@ -41,6 +43,19 @@ function accessor( value ) {
 	return value * 2.0;
 }
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.8 ) < 1 ) {
+		return NaN;
+	}
+	return uniform( -50.0, 50.0 );
+}
+
 /**
 * Create a benchmark function.
 *
@@ -49,17 +64,7 @@ function accessor( value ) {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = [];
-	for ( i = 0; i < len; i++ ) {
-		if ( randu() < 0.2 ) {
-			x.push( NaN );
-		} else {
-			x.push( ( randu()*20.0 ) - 10.0 );
-		}
-	}
+	var x = filledarrayBy( len, 'generic', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/nanmax-by/benchmark/benchmark.ndarray.js

@@ -21,7 +21,9 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var pkg = require( './../package.json' ).name;
@@ -41,6 +43,19 @@ function accessor( value ) {
 	return value * 2.0;
 }
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.8 ) < 1 ) {
+		return NaN;
+	}
+	return uniform( -50.0, 50.0 );
+}
+
 /**
 * Create a benchmark function.
 *
@@ -49,17 +64,7 @@ function accessor( value ) {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = [];
-	for ( i = 0; i < len; i++ ) {
-		if ( randu() < 0.2 ) {
-			x.push( NaN );
-		} else {
-			x.push( ( randu()*20.0 ) - 10.0 );
-		}
-	}
+	var x = filledarrayBy( len, 'generic', rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/nanmax-by/docs/repl.txt

@@ -1,10 +1,10 @@
 
-{{alias}}( N, x, stride, clbk[, thisArg] )
-    Calculates the maximum value of a strided array via a callback function,
+{{alias}}( N, x, strideX, clbk[, thisArg] )
+    Computes the maximum value of strided array via a callback function,
     ignoring `NaN` values.
 
-    The `N` and `stride` parameters determine which elements in `x` are accessed
-    at runtime.
+    The `N` and stride parameters determine which elements in the strided array
+    are accessed at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use typed
     array views.
@@ -34,8 +34,8 @@
         Input array/collection. If provided an object, the object must be array-
         like (excluding strings and functions).
 
-    stride: integer
-        Index increment for `x`.
+    strideX: integer
+        Stride length.
 
     clbk: Function
         Callback function.
@@ -56,25 +56,24 @@
     > {{alias}}( x.length, x, 1, accessor )
     8.0
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, x, 2, accessor )
+    > {{alias}}( 3, x, 2, accessor )
     8.0
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
     > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, x1, 2, accessor )
+    > {{alias}}( 3, x1, 2, accessor )
     -4.0
 
-{{alias}}.ndarray( N, x, stride, offset, clbk[, thisArg] )
-    Calculates the maximum value of a strided array via a callback function,
+
+{{alias}}.ndarray( N, x, strideX, offsetX, clbk[, thisArg] )
+    Computes the maximum value of a strided array via a callback function,
     ignoring `NaN` values and using alternative indexing semantics.
 
     While typed array views mandate a view offset based on the underlying
-    buffer, the `offset` parameter supports indexing semantics based on a
+    buffer, the offset parameter supports indexing semantics based on a
     starting index.
 
     Parameters
@@ -86,11 +85,11 @@
         Input array/collection. If provided an object, the object must be array-
         like (excluding strings and functions).
 
-    stride: integer
-        Index increment for `x`.
+    strideX: integer
+        Stride length.
 
-    offset: integer
-        Starting index of `x`.
+    offsetX: integer
+        Starting index.
 
     clbk: Function
         Callback function.
@@ -113,8 +112,7 @@
 
     // Using an index offset:
     > x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, x, 2, 1, accessor )
+    > {{alias}}.ndarray( 3, x, 2, 1, accessor )
     -4.0
 
     See Also

lib/node_modules/@stdlib/stats/base/nanmax-by/docs/types/index.d.ts

@@ -20,7 +20,12 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
+import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
 
 /**
 * Returns an accessed value.
@@ -83,7 +88,7 @@ type Callback<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U> |
 */
 interface Routine {
 	/**
-	* Calculates the maximum value of a strided array via a callback function, ignoring `NaN` values.
+	* Computes the maximum value of a strided array via a callback function, ignoring `NaN` values.
 	*
 	* ## Notes
 	*
@@ -102,7 +107,7 @@ interface Routine {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @param clbk - callback
 	* @param thisArg - execution context
 	* @returns maximum value
@@ -117,10 +122,10 @@ interface Routine {
 	* var v = nanmaxBy( x.length, x, 1, accessor );
 	* // returns 8.0
 	*/
-	<T = unknown, U = unknown>( N: number, x: Collection<T>, stride: number, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): number;
+	<T = unknown, U = unknown>( N: number, x: InputArray, strideX: number, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): number;
 
 	/**
-	* Calculates the maximum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics.
+	* Computes the maximum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics.
 	*
 	* ## Notes
 	*
@@ -139,8 +144,8 @@ interface Routine {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
-	* @param offset - starting index
+	* @param strideX - stride length
+	* @param offsetX - starting index
 	* @param clbk - callback
 	* @param thisArg - execution context
 	* @returns maximum value
@@ -155,11 +160,11 @@ interface Routine {
 	* var v = nanmaxBy.ndarray( x.length, x, 1, 0, accessor );
 	* // returns 8.0
 	*/
-	ndarray<T = unknown, U = unknown>( N: number, x: Collection<T>, stride: number, offset: number, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): number;
+	ndarray<T = unknown, U = unknown>( N: number, x: InputArray, strideX: number, offsetX: number, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): number;
 }
 
 /**
-* Calculates the maximum value of a strided array via a callback function, ignoring `NaN` values.
+* Computes the maximum value of a strided array via a callback function, ignoring `NaN` values.
 *
 * ## Notes
 *
@@ -178,7 +183,7 @@ interface Routine {
 *
 * @param N - number of indexed elements
 * @param x - input array
-* @param stride - stride length
+* @param strideX - stride length
 * @param clbk - callback
 * @param thisArg - execution context
 * @returns maximum value