refactor: update blas/ext/base/gcusum to follow current project con…

…ventions PR-URL: stdlib-js#4435 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
saurabhraghuvanshii · Jan 18, 2025 · 805ac35 · 805ac35
1 parent 2ed29ff
commit 805ac35
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 97 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/gcusum/README.md
@@ -59,21 +59,17 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **sum**: initial sum.
 -   **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 sum 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 sum of every other element:
 
 ```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
-
 var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
-var N = floor( x.length / 2 );
-
-var v = gcusum( N, 0.0, x, 2, y, 1 );
+var v = gcusum( 4, 0.0, x, 2, y, 1 );
 // y => [ 1.0, 3.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 ```
 
@@ -83,7 +79,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 // Initial arrays...
 var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
@@ -93,9 +88,7 @@ var y0 = new Float64Array( x0.length );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
 
-var N = floor( x0.length / 2 );
-
-gcusum( N, 0.0, x1, -2, y1, 1 );
+gcusum( 4, 0.0, x1, -2, y1, 1 );
 // y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 6.0, 4.0, 5.0, 0.0 ]
 ```
 
@@ -116,17 +109,13 @@ 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 sum 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 sum of every other element in the strided input array starting from the second element and to store in the last `N` elements of the strided output array starting from the last element:
 
 ```javascript
-var floor = require( '@stdlib/math/base/special/floor' );
-
 var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
-var N = floor( x.length / 2 );
-
-gcusum.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 );
+gcusum.ndarray( 4, 0.0, x, 2, 1, y, -1, y.length-1 );
 // y => [ 0.0, 0.0, 0.0, 0.0, 5.0, 1.0, -1.0, 1.0 ]
 ```
 
@@ -152,20 +141,14 @@ gcusum.ndarray( N, 0.0, 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 gcusum = require( '@stdlib/blas/ext/base/gcusum' );
 
-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, -100, 100, {
+    'dtype': 'float64'
+});
+var y = new Float64Array( x.length );
 console.log( x );
 console.log( y );
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/gcusum/benchmark/benchmark.js
@@ -21,14 +21,22 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var gfill = require( '@stdlib/blas/ext/base/gfill' );
+var zeros = require( '@stdlib/array/zeros' );
 var pkg = require( './../package.json' ).name;
 var gcusum = require( './../lib/main.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -39,16 +47,8 @@ var gcusum = require( './../lib/main.js' );
 * @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, -100, 100, options );
+	var y = zeros( len, options.dtype );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/gcusum/benchmark/benchmark.ndarray.js
@@ -21,14 +21,22 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var gfill = require( '@stdlib/blas/ext/base/gfill' );
+var zeros = require( '@stdlib/array/zeros' );
 var pkg = require( './../package.json' ).name;
 var gcusum = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -39,16 +47,8 @@ var gcusum = 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, -100, 100, options );
+	var y = zeros( len, options.dtype );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/gcusum/docs/repl.txt
@@ -2,8 +2,8 @@
 {{alias}}( N, sum, x, strideX, y, strideY )
     Computes the cumulative sum of strided array elements.
 
-    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.
@@ -22,13 +22,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
     -------
@@ -43,31 +43,30 @@
     > {{alias}}( x.length, 0.0, 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, 0.0, x, 2, y, 2 )
+    > {{alias}}( 3, 0.0, 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, 0.0, x1, 2, y1, 1 )
+    > {{alias}}( 3, 0.0, x1, 2, y1, 1 )
     <Float64Array>[ -2.0, 0.0, -1.0 ]
     > y0
     <Float64Array>[ 0.0, 0.0, 0.0, -2.0, 0.0, -1.0 ]
 
+
 {{alias}}.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY )
     Computes the cumulative sum of strided array elements 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
-    starting index.
+    buffer, the offset parameters support indexing semantics based on starting
+    indices.
 
     Parameters
     ----------
@@ -81,7 +80,7 @@
         Input array.
 
     strideX: integer
-        Index increment for `x`.
+        Stride length for `x`.
 
     offsetX: integer
         Starting index for `x`.
@@ -90,7 +89,7 @@
         Output array.
 
     strideY: integer
-        Index increment for `y`.
+        Stride length for `y`.
 
     offsetY: integer
         Starting index for `y`.
@@ -106,14 +105,13 @@
     > var x = [ 1.0, -2.0, 2.0 ];
     > var y = [ 0.0, 0.0, 0.0 ];
     > {{alias}}.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 )
-    <Float64Array>[ 1.0, -1.0, 1.0 ]
+    [ 1.0, -1.0, 1.0 ]
 
     // 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, 0.0, x, 2, 1, y, -1, y.length-1 )
-    <Float64Array>[ 0.0, 0.0, 0.0, -1.0, 0.0, -2.0 ]
+    > {{alias}}.ndarray( 3, 0.0, x, 2, 1, y, -1, y.length-1 )
+    [ 0.0, 0.0, 0.0, -1.0, 0.0, -2.0 ]
 
     See Also
     --------

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gcusum/docs/types/index.d.ts
@@ -32,9 +32,9 @@ interface Routine {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @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
@@ -52,10 +52,10 @@ interface Routine {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @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
 	*
@@ -75,9 +75,9 @@ interface Routine {
 * @param N - number of indexed elements
 * @param sum - initial sum
 * @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

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/gcusum/examples/index.js
@@ -18,20 +18,14 @@
 
 'use strict';
 
-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 gcusum = require( './../lib' );
 
-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, -100, 100, {
+	'dtype': 'float64'
+});
+var y = new Float64Array( x.length );
 console.log( x );
 console.log( y );
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/gcusum/lib/index.js
@@ -38,9 +38,8 @@
 *
 * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
 * var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
-* var N = floor( x.length / 2 );
 *
-* gcusum.ndarray( N, 0.0, x, 2, 1, y, 1, 0 );
+* gcusum.ndarray( 4, 0.0, x, 2, 1, y, 1, 0 );
 * // y => [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 */
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/gcusum/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/gcusum/lib/main.js
@@ -20,7 +20,8 @@
 
 // MODULES //
 
-var gcusumkbn = require( '@stdlib/blas/ext/base/gcusumkbn' );
+var stride2offset = require( '@stdlib/strided/base/stride2offset' );
+var ndarray = require( './ndarray.js' );
 
 
 // MAIN //
@@ -31,9 +32,9 @@ var gcusumkbn = require( '@stdlib/blas/ext/base/gcusumkbn' );
 * @param {PositiveInteger} N - number of indexed elements
 * @param {number} sum - initial sum
 * @param {NumericArray} x - input array
-* @param {integer} strideX - `x` stride length
+* @param {integer} strideX - stride length for `x`
 * @param {NumericArray} y - output array
-* @param {integer} strideY - `y` stride length
+* @param {integer} strideY - stride length for `y`
 * @returns {NumericArray} output array
 *
 * @example
@@ -44,7 +45,9 @@ var gcusumkbn = require( '@stdlib/blas/ext/base/gcusumkbn' );
 * // returns [ 1.0, -1.0, 1.0 ]
 */
 function gcusum( N, sum, x, strideX, y, strideY ) {
-	return gcusumkbn( N, sum, x, strideX, y, strideY );
+	var ox = stride2offset( N, strideX );
+	var oy = stride2offset( N, strideY );
+	return ndarray( N, sum, x, strideX, ox, y, strideY, oy );
 }