refactor and add protocol support to stats/base/nanrange-by

Author: Kaushikgtm

lib/node_modules/@stdlib/stats/base/nanrange-by/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.
@@ -38,7 +38,7 @@ The [**range**][range] is defined as the difference between the maximum and mini
 var nanrangeBy = require( '@stdlib/stats/base/nanrange-by' );
 ```
 
-#### nanrangeBy( N, x, stride, clbk\[, thisArg] )
+#### nanrangeBy( N, x, strideX, clbk\[, thisArg] )
 
 Calculates the [range][range] of strided array `x` via a callback function, ignoring `NaN` values.
 
@@ -57,15 +57,15 @@ 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**: index increment.
 -   **clbk**: callback function.
 -   **thisArg**: execution context (_optional_).
 
 The invoked callback is provided four arguments:
 
 -   **value**: array element.
 -   **aidx**: array index.
--   **sidx**: strided index (`offset + aidx*stride`).
+-   **sidx**: strided index (`offsetX + aidx*strideX`).
 -   **array**: input array/collection.
 
 To set the callback execution context, provide a `thisArg`.
@@ -89,7 +89,7 @@ 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 `strideX` parameters determine which elements in `x` are accessed at runtime. For example, to access every other element
 
 ```javascript
 var floor = require( '@stdlib/math/base/special/floor' );
@@ -127,7 +127,7 @@ var v = nanrangeBy( N, x1, 2, accessor );
 // returns 8.0
 ```
 
-#### nanrangeBy.ndarray( N, x, stride, offset, clbk\[, thisArg] )
+#### nanrangeBy.ndarray( N, x, strideX, offsetX, clbk\[, thisArg] )
 
 Calculates the [range][range] of strided array `x` via a callback function, ignoring `NaN` values and using alternative indexing semantics.
 
@@ -144,9 +144,9 @@ var v = nanrangeBy.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 `offsetX` parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
 
 ```javascript
 function accessor( v ) {
@@ -185,22 +185,23 @@ var v = nanrangeBy.ndarray( 3, x, 1, x.length-3, accessor );
 
 ```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 nanrangeBy = require( '@stdlib/stats/base/nanrange-by' );
 
-function fill() {
-    if ( randu() < 0.2 ) {
+function rand() {
+    if ( bernoulli( 0.8 ) < 1 ) {
         return NaN;
     }
-    return discreteUniform( -50, 50 );
+    return uniform( -50.0, 50.0 );
 }
 
 function accessor( v ) {
     return v * 2.0;
 }
 
-var x = filledarrayBy( 10, 'float64', fill );
+var x = filledarrayBy( 10, 'float64', rand );
 console.log( x );
 
 var v = nanrangeBy( x.length, x, 1, accessor );
@@ -235,23 +236,17 @@ console.log( v );
 <section class="links">
 
 [range]: https://en.wikipedia.org/wiki/Range_%28statistics%29
-
 [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/dnanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanrange
-
 [@stdlib/stats/base/nanmax-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmax-by
-
 [@stdlib/stats/base/nanmin-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmin-by
-
 [@stdlib/stats/base/nanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanrange
-
 [@stdlib/stats/base/range-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/range-by
-
 [@stdlib/stats/base/snanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanrange
 
 <!-- </related-links> -->

lib/node_modules/@stdlib/stats/base/nanrange-by/benchmark/benchmark.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;
@@ -37,6 +39,13 @@ var nanrangeBy = require( './../lib/nanrange_by.js' );
 * @param {number} value - array element
 * @returns {number} accessed value
 */
+function rand() {
+	if ( bernoulli( 0.8 ) < 1 ) {
+		return NaN;
+	}
+	return uniform( -50.0, 50.0 );
+}
+
 function accessor( value ) {
 	return value * 2.0;
 }
@@ -49,17 +58,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, "float64", rand );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/stats/base/nanrange-by/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,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;
@@ -37,6 +39,13 @@ var nanrangeBy = require( './../lib/ndarray.js' );
 * @param {number} value - array element
 * @returns {number} accessed value
 */
+function rand() {
+	if ( bernoulli( 0.8 ) < 1 ) {
+		return NaN;
+	}
+	return uniform( -50.0, 50.0 );
+}
+
 function accessor( value ) {
 	return value * 2.0;
 }
@@ -49,17 +58,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, "float64", rand );
 	return benchmark;
 
 	function benchmark( b ) {

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

@@ -1,9 +1,9 @@
 
-{{alias}}( N, x, stride, clbk[, thisArg] )
+{{alias}}( N, x, strideX, clbk[, thisArg] )
     Calculates the range of a strided array via a callback function, ignoring
     `NaN` values.
 
-    The `N` and `stride` parameters determine which elements in `x` are accessed
+    The `N` and `strideX` parameters determine which elements in `x` are accessed
     at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use typed
@@ -15,7 +15,7 @@
 
     - value: array element.
     - aidx: array index.
-    - sidx: strided index (offset + aidx*stride).
+    - sidx: strided index (offsetX + aidx*strideX).
     - array: the input array.
 
     The callback function should return a numeric value.
@@ -34,7 +34,7 @@
         Input array/collection. If provided an object, the object must be array-
         like (excluding strings and functions).
 
-    stride: integer
+    strideX: integer
         Index increment for `x`.
 
     clbk: Function
@@ -56,7 +56,7 @@
     > {{alias}}( x.length, x, 1, accessor )
     18.0
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and `strideX` parameters:
     > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0, 1.0 ];
     > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
     > {{alias}}( N, x, 2, accessor )
@@ -69,12 +69,12 @@
     > {{alias}}( N, x1, 2, accessor )
     8.0
 
-{{alias}}.ndarray( N, x, stride, offset, clbk[, thisArg] )
+{{alias}}.ndarray( N, x, strideX, offsetX, clbk[, thisArg] )
     Calculates the range 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 `offsetX` parameter supports indexing semantics based on a
     starting index.
 
     Parameters
@@ -86,10 +86,10 @@
         Input array/collection. If provided an object, the object must be array-
         like (excluding strings and functions).
 
-    stride: integer
+    strideX: integer
         Index increment for `x`.
 
-    offset: integer
+    offsetX: integer
         Starting index of `x`.
 
     clbk: Function

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

@@ -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.
@@ -20,7 +20,11 @@
 
 /// <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.
@@ -61,7 +65,7 @@ type Ternary<T, U> = ( this: U, value: T, aidx: number, sidx: number ) => number
 *
 * @param value - array element
 * @param aidx - array index
-* @param sidx - strided index (offset + aidx*stride)
+* @param sidx - strided index (offsetX + aidx*strideX)
 * @param array - input array
 * @returns accessed value
 */
@@ -72,7 +76,7 @@ type Quaternary<T, U> = ( this: U, value: T, aidx: number, sidx: number, array:
 *
 * @param value - array element
 * @param aidx - array index
-* @param sidx - strided index (offset + aidx*stride)
+* @param sidx - strided index (offsetX + aidx*strideX)
 * @param array - input array
 * @returns accessed value
 */
@@ -102,7 +106,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 range
@@ -117,7 +121,7 @@ interface Routine {
 	* var v = nanrangeBy( x.length, x, 1, accessor );
 	* // returns 18.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, stride: number, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): number;
 
 	/**
 	* Calculates the range of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics.
@@ -128,7 +132,7 @@ interface Routine {
 	*
 	*     -   `value`: array element
 	*     -   `aidx`: array index
-	*     -   `sidx`: strided index (offset + aidx*stride)
+	*     -   `sidx`: strided index (offsetX + aidx*strideX)
 	*     -   `array`: input array
 	*
 	* -   The callback function should return a numeric value.
@@ -139,8 +143,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 range
@@ -155,7 +159,7 @@ interface Routine {
 	* var v = nanrangeBy.ndarray( x.length, x, 1, 0, accessor );
 	* // returns 18.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, stride: number, offset: number, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): number;
 }
 
 /**
@@ -167,7 +171,7 @@ interface Routine {
 *
 *     -   `value`: array element
 *     -   `aidx`: array index
-*     -   `sidx`: strided index (offset + aidx*stride)
+*     -   `sidx`: strided index (offsetX + aidx*strideX)
 *     -   `array`: input array
 *
 * -   The callback function should return a numeric value.
@@ -178,7 +182,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 range