refactor: update blas/ext/base/scusumors

PR-URL: #1945
Closes: #1519

---------

Signed-off-by: Bryan Elee <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

Author: rxbryan

lib/node_modules/@stdlib/blas/ext/base/scusumors/README.md

@@ -65,18 +65,15 @@ The function has the following parameters:
 -   **y**: output [`Float32Array`][@stdlib/array/float32].
 -   **strideY**: index increment 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 in `x`,
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
 var y = new Float32Array( x.length );
 
-var N = floor( x.length / 2 );
-
-var v = scusumors( N, 0.0, x, 2, y, 1 );
+var v = scusumors( 4, 0.0, x, 2, y, 1 );
 // y => <Float32Array>[ 1.0, 3.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 ```
 
@@ -86,7 +83,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 // Initial arrays...
 var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
@@ -96,9 +92,7 @@ var y0 = new Float32Array( x0.length );
 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
 
-var N = floor( x0.length / 2 );
-
-scusumors( N, 0.0, x1, -2, y1, 1 );
+scusumors( 4, 0.0, x1, -2, y1, 1 );
 // y0 => <Float32Array>[ 0.0, 0.0, 0.0, 4.0, 6.0, 4.0, 5.0, 0.0 ]
 ```
 
@@ -121,18 +115,15 @@ 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 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
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 var y = new Float32Array( x.length );
 
-var N = floor( x.length / 2 );
-
-scusumors.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 );
+scusumors.ndarray( 4, 0.0, x, 2, 1, y, -1, y.length-1 );
 // y => <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 5.0, 1.0, -1.0, 1.0 ]
 ```
 
@@ -144,7 +135,7 @@ scusumors.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 );
 
 ## Notes
 
--   If `N <= 0`, both functions return `y` unchanged.
+-   If `N <= 0`, both functions return the output array unchanged.
 -   Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation is acceptable; in all other cases, exercise due caution.
 
 </section>
@@ -158,20 +149,14 @@ scusumors.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/base/discrete-uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var Float32Array = require( '@stdlib/array/float32' );
 var scusumors = require( '@stdlib/blas/ext/base/scusumors' );
 
-var y;
-var x;
-var i;
+var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
+var y = new Float32Array( x.length );
 
-x = new Float32Array( 10 );
-y = new Float32Array( x.length );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = round( randu()*100.0 );
-}
 console.log( x );
 console.log( y );
 

lib/node_modules/@stdlib/blas/ext/base/scusumors/benchmark/benchmark.js

@@ -21,7 +21,8 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var Float32Array = require( '@stdlib/array/float32' );
@@ -41,13 +42,10 @@ var scusumors = require( './../lib/scusumors.js' );
 function createBenchmark( len ) {
 	var y;
 	var x;
-	var i;
 
-	x = new Float32Array( len );
+	x = filledarrayBy( len, 'float32', uniform( -10.0, 10.0 ) );
 	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumors/benchmark/benchmark.native.js

@@ -22,7 +22,8 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var Float32Array = require( '@stdlib/array/float32' );
@@ -50,13 +51,10 @@ var opts = {
 function createBenchmark( len ) {
 	var x;
 	var y;
-	var i;
 
-	x = new Float32Array( len );
+	x = filledarrayBy( len, 'float32', uniform( -10.0, 10.0 ) );
 	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumors/benchmark/benchmark.ndarray.js

@@ -21,7 +21,8 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var Float32Array = require( '@stdlib/array/float32' );
@@ -41,13 +42,10 @@ var scusumors = require( './../lib/ndarray.js' );
 function createBenchmark( len ) {
 	var x;
 	var y;
-	var i;
 
-	x = new Float32Array( len );
+	x = filledarrayBy( len, 'float32', uniform( -10.0, 10.0 ) );
 	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumors/benchmark/benchmark.ndarray.native.js

@@ -22,7 +22,8 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var Float32Array = require( '@stdlib/array/float32' );
@@ -50,13 +51,10 @@ var opts = {
 function createBenchmark( len ) {
 	var x;
 	var y;
-	var i;
 
-	x = new Float32Array( len );
+	x = filledarrayBy( len, 'float32', uniform( -10.0, 10.0 ) );
 	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/scusumors/docs/repl.txt

@@ -3,8 +3,8 @@
     Computes the cumulative sum of single-precision floating-point strided array
     elements using ordinary recursive summation.
 
-    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.
@@ -44,24 +44,23 @@
     > {{alias}}( x.length, 0.0, x, 1, y, 1 )
     <Float32Array>[ 1.0, -1.0, 1.0 ]
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
     > y = new {{alias:@stdlib/array/float32}}( x.length );
-    > 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 )
     <Float32Array>[ -2.0, 0.0, -1.0, 0.0, 1.0, 0.0 ]
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     > var y0 = new {{alias:@stdlib/array/float32}}( x0.length );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
     > var y1 = new {{alias:@stdlib/array/float32}}( 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 )
     <Float32Array>[ -2.0, 0.0, -1.0 ]
     > y0
     <Float32Array>[ 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 single-precision floating-point strided array
     elements using ordinary recursive summation and alternative indexing
@@ -113,8 +112,7 @@
     // Advanced indexing:
     > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     > y = new {{alias:@stdlib/array/float32}}( x.length );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 )
+    > {{alias}}.ndarray( 3, 0.0, x, 2, 1, y, -1, y.length-1 )
     <Float32Array>[ 0.0, 0.0, 0.0, -1.0, 0.0, -2.0 ]
 
     See Also

lib/node_modules/@stdlib/blas/ext/base/scusumors/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 Float32Array = require( '@stdlib/array/float32' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var scusumors = require( './../lib' );
 
-var y;
-var x;
-var i;
+var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
+var y = new Float32Array( x.length );
 
-x = new Float32Array( 10 );
-y = new Float32Array( x.length );
-for ( i = 0; i < x.length; i++ ) {
-	x[ i ] = round( randu()*100.0 );
-}
 console.log( x );
 console.log( y );
 

lib/node_modules/@stdlib/blas/ext/base/scusumors/include.gypi

@@ -36,7 +36,7 @@
 
     # Source files:
     'src_files': [
-      '<(src_dir)/addon.cpp',
+      '<(src_dir)/addon.c',
       '<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
     ],
 

lib/node_modules/@stdlib/blas/ext/base/scusumors/lib/index.js

@@ -36,14 +36,12 @@
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 * var scusumors = require( '@stdlib/blas/ext/base/scusumors' );
 *
 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 * var y = new Float32Array( x.length );
-* var N = floor( x.length / 2 );
 *
-* scusumors.ndarray( N, 0.0, x, 2, 1, y, 1, 0 );
+* scusumors.ndarray( 4, 0.0, x, 2, 1, y, 1, 0 );
 * // y => <Float32Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 */
 

lib/node_modules/@stdlib/blas/ext/base/scusumors/lib/ndarray.js

@@ -40,13 +40,11 @@ var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 *
 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 * var y = new Float32Array( x.length );
-* var N = floor( x.length / 2 );
 *
-* var v = scusumors( N, 0.0, x, 2, 1, y, 1, 0 );
+* var v = scusumors( 4, 0.0, x, 2, 1, y, 1, 0 );
 * // returns <Float32Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 */
 function scusumors( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {

lib/node_modules/@stdlib/blas/ext/base/scusumors/lib/ndarray.native.js

@@ -20,7 +20,8 @@
 
 // MODULES //
 
-var Float32Array = require( '@stdlib/array/float32' );
+var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
+var offsetView = require( '@stdlib/strided/base/offset-view' );
 var addon = require( './scusumors.native.js' );
 
 
@@ -41,26 +42,23 @@ var addon = require( './scusumors.native.js' );
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 *
 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 * var y = new Float32Array( x.length );
-* var N = floor( x.length / 2 );
 *
-* var v = scusumors( N, 0.0, x, 2, 1, y, 1, 0 );
+* var v = scusumors( 4, 0.0, x, 2, 1, y, 1, 0 );
 * // returns <Float32Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
 */
 function scusumors( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
 	var viewX;
 	var viewY;
-	if ( strideX < 0 ) {
-		offsetX += (N-1) * strideX;
-	}
-	if ( strideY < 0 ) {
-		offsetY += (N-1) * strideY;
-	}
-	viewX = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offsetX), x.length-offsetX ); // eslint-disable-line max-len
-	viewY = new Float32Array( y.buffer, y.byteOffset+(y.BYTES_PER_ELEMENT*offsetY), y.length-offsetY ); // eslint-disable-line max-len
+
+	offsetX = minViewBufferIndex( N, strideX, offsetX );
+	offsetY = minViewBufferIndex( N, strideY, offsetY );
+
+	viewX = offsetView( x, offsetX );
+	viewY = offsetView( y, offsetY );
+
 	addon( N, sum, viewX, strideX, viewY, strideY );
 	return y;
 }