feat: add support for accessor arrays and refactor stats/base/cuminabs

PR-URL: #7575
Closes: #5645
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Co-authored-by: Gururaj Gurram <[email protected]>
Reviewed-by: Gururaj Gurram <[email protected]>

Author: 3 people

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

@@ -52,11 +52,11 @@ 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`.
+-   **strideX**: stride length for `x`.
 -   **y**: output [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
--   **strideY**: index increment for `y`.
+-   **strideY**: stride length for `y`.
 
-The `N` and `stride` parameters determine which elements in `x` and `y` are accessed at runtime. For example, to compute the cumulative minimum absolute 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 cumulative minimum absolute value of every other element in `x`,
 
 ```javascript
 var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
@@ -102,7 +102,7 @@ The function has the following additional parameters:
 -   **offsetX**: starting index for `x`.
 -   **offsetY**: starting index for `y`.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, `offsetX` and `offsetY` parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative minimum absolute value of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative minimum absolute value of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element
 
 ```javascript
 var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
@@ -122,6 +122,7 @@ cuminabs.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
 
 -   If `N <= 0`, both functions return `y` unchanged.
 -   Depending on the environment, the typed versions ([`dcuminabs`][@stdlib/stats/strided/dcuminabs], [`scuminabs`][@stdlib/stats/strided/scuminabs], 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>
 
@@ -134,20 +135,14 @@ cuminabs.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random/base/randu' );
-var round = require( '@stdlib/math/base/special/round' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
 var Float64Array = require( '@stdlib/array/float64' );
 var cuminabs = require( '@stdlib/stats/base/cuminabs' );
 
-var y;
-var x;
-var i;
-
-x = new Float64Array( 10 );
-y = new Float64Array( x.length );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = round( randu()*100.0 );
-}
+var x = discreteUniform( 10, 0, 100, {
+    'dtype': 'float64'
+});
+var y = new Float64Array( x.length );
 console.log( x );
 console.log( y );
 
@@ -188,6 +183,8 @@ console.log( y );
 
 [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> -->

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

@@ -21,13 +21,22 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var zeros = require( '@stdlib/array/zeros' );
+var gfill = require( '@stdlib/blas/ext/base/gfill' );
 var pkg = require( './../package.json' ).name;
 var cuminabs = require( './../lib' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,35 +47,26 @@ var cuminabs = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var y;
-	var x;
-	var i;
-
-	x = [];
-	y = [];
-	for ( i = 0; i < len; i++ ) {
-		x.push( ( randu()*20.0 ) - 10.0 );
-		y.push( 0.0 );
-	}
+	var x = uniform( len, -10, 10, options );
+	var y = zeros( len, options.dtype );
 	return benchmark;
 
 	function benchmark( b ) {
 		var v;
 		var i;
 
-		for ( i = 0; i < len; i++ ) {
-			y[ i ] = 0.0;
-		}
+		gfill( len, 0.0, y, 1 );
+
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
 			x[ 0 ] += 1.0;
 			v = cuminabs( x.length, x, 1, y, 1 );
-			if ( isnan( v[ i%len ] ) ) {
+			if ( isnan( v[ i % len ] ) ) {
 				b.fail( 'should not return NaN' );
 			}
 		}
 		b.toc();
-		if ( isnan( v[ i%len ] ) ) {
+		if ( isnan( v[ i % len ] ) ) {
 			b.fail( 'should not return NaN' );
 		}
 		b.pass( 'benchmark finished' );

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

@@ -21,13 +21,22 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var zeros = require( '@stdlib/array/zeros' );
+var gfill = require( '@stdlib/blas/ext/base/gfill' );
 var pkg = require( './../package.json' ).name;
 var cuminabs = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,35 +47,26 @@ var cuminabs = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var y;
-	var i;
-
-	x = [];
-	y = [];
-	for ( i = 0; i < len; i++ ) {
-		x.push( ( randu()*20.0 ) - 10.0 );
-		y.push( 0.0 );
-	}
+	var x = uniform( len, -10, 10, options );
+	var y = zeros( len, options.dtype );
 	return benchmark;
 
 	function benchmark( b ) {
 		var v;
 		var i;
 
-		for ( i = 0; i < len; i++ ) {
-			y[ i ] = 0.0;
-		}
+		gfill( len, 0.0, y, 1 );
+
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
 			x[ 0 ] += 1.0;
 			v = cuminabs( x.length, x, 1, 0, y, 1, 0 );
-			if ( isnan( v[ i%len ] ) ) {
+			if ( isnan( v[ i % len ] ) ) {
 				b.fail( 'should not return NaN' );
 			}
 		}
 		b.toc();
-		if ( isnan( v[ i%len ] ) ) {
+		if ( isnan( v[ i % len ] ) ) {
 			b.fail( 'should not return NaN' );
 		}
 		b.pass( 'benchmark finished' );

lib/node_modules/@stdlib/stats/base/cuminabs/docs/repl.txt

@@ -2,8 +2,8 @@
 {{alias}}( N, x, strideX, y, strideY )
     Computes the cumulative minimum absolute value of a strided array.
 
-    The `N` and `stride` parameters determine which elements in `x` and `y` are
-    accessed at runtime.
+    The `N` and stride parameters determine which elements in the strided arrays
+    are accessed at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use a typed
     array view.
@@ -19,13 +19,13 @@
         Input array.
 
     strideX: integer
-        Index increment for `x`.
+        Stride length for `x`.
 
     y: Array<number>|TypedArray
         Output array.
 
     strideY: integer
-        Index increment for `y`.
+        Stride length for `y`.
 
     Returns
     -------
@@ -40,24 +40,23 @@
     > {{alias}}( x.length, x, 1, y, 1 )
     [ 1.0, 1.0, 1.0 ]
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];
     > y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, x, 2, y, 2 )
+    > {{alias}}( 3, x, 2, y, 2 )
     [ 2.0, 0.0, 1.0, 0.0, 1.0, 0.0 ]
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     > var y0 = new {{alias:@stdlib/array/float64}}( x0.length );
     > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
     > var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*3 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, x1, 2, y1, 1 )
+    > {{alias}}( 3, x1, 2, y1, 1 )
     <Float64Array>[ 2.0, 2.0, 1.0 ]
     > y0
     <Float64Array>[ 0.0, 0.0, 0.0, 2.0, 2.0, 1.0 ]
 
+
 {{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
     Computes the cumulative minimum absolute value of a strided array using
     alternative indexing semantics.
@@ -75,7 +74,7 @@
         Input array.
 
     strideX: integer
-        Index increment for `x`.
+        Stride length for `x`.
 
     offsetX: integer
         Starting index for `x`.
@@ -84,7 +83,7 @@
         Output array.
 
     strideY: integer
-        Index increment for `y`.
+        Stride length for `y`.
 
     offsetY: integer
         Starting index for `y`.
@@ -105,8 +104,7 @@
     // Advanced indexing:
     > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
     > y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, x, 2, 1, y, -1, y.length-1 )
+    > {{alias}}.ndarray( 3, x, 2, 1, y, -1, y.length-1 )
     [ 0.0, 0.0, 0.0, 1.0, 2.0, 2.0 ]
 
     See Also

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

@@ -20,7 +20,17 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { NumericArray } from '@stdlib/types/array';
+import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Input array.
+*/
+type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
+
+/**
+* Output array.
+*/
+type OutputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
 
 /**
 * Interface describing `cuminabs`.
@@ -31,9 +41,9 @@ interface Routine {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @returns output array
 	*
 	* @example
@@ -43,17 +53,17 @@ interface Routine {
 	* cuminabs( x.length, x, 1, y, 1 );
 	* // y => [ 1.0, 1.0, 1.0 ]
 	*/
-	( N: number, x: NumericArray, strideX: number, y: NumericArray, strideY: number ): NumericArray;
+	<T extends OutputArray>( N: number, x: InputArray, strideX: number, y: T, strideY: number ): T;
 
 	/**
 	* Computes the cumulative minimum absolute value of a strided array using alternative indexing semantics.
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param offsetX - starting index for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @param offsetY - starting index for `y`
 	* @returns output array
 	*
@@ -64,17 +74,17 @@ interface Routine {
 	* cuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
 	* // y => [ 1.0, 1.0, 1.0 ]
 	*/
-	ndarray( N: number, x: NumericArray, strideX: number, offsetX: number, y: NumericArray, strideY: number, offsetY: number ): NumericArray;
+	ndarray<T extends OutputArray>( N: number, x: InputArray, strideX: number, offsetX: number, y: T, strideY: number, offsetY: number ): T;
 }
 
 /**
 * Computes the cumulative minimum absolute value of a strided array.
 *
 * @param N - number of indexed elements
 * @param x - input array
-* @param strideX - `x` stride length
+* @param strideX - stride length for `x`
 * @param y - output array
-* @param strideY - `y` stride length
+* @param strideY - stride length for `y`
 * @returns output array
 *
 * @example

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

@@ -16,6 +16,7 @@
 * limitations under the License.
 */
 
+import AccessorArray = require( '@stdlib/array/base/accessor' );
 import cuminabs = require( './index' );
 
 
@@ -26,7 +27,8 @@ import cuminabs = require( './index' );
 	const x = new Float64Array( 10 );
 	const y = new Float64Array( 10 );
 
-	cuminabs( x.length, x, 1, y, 1 ); // $ExpectType NumericArray
+	cuminabs( x.length, x, 1, y, 1 ); // $ExpectType Float64Array
+	cuminabs( x.length, new AccessorArray( x ), 1, new AccessorArray( y ), 1 ); // $ExpectType AccessorArray<number>
 }
 
 // The compiler throws an error if the function is provided a first argument which is not a number...
@@ -123,7 +125,8 @@ import cuminabs = require( './index' );
 	const x = new Float64Array( 10 );
 	const y = new Float64Array( 10 );
 
-	cuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType NumericArray
+	cuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Float64Array
+	cuminabs.ndarray( x.length, new AccessorArray( x ), 1, 0, new AccessorArray( y ), 1, 0 ); // $ExpectType AccessorArray<number>
 }
 
 // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...