refactor: blas/ext/base/sapxsumkbn2 to follow current project conve…

…ntions PR-URL: #1966 Closes: #1512 --------- Signed-off-by: Shivam <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Mar 24, 2024 · 8e8b47c · 8e8b47c · stdlib-bot · Mar 24, 2024
1 parent f5dbe2d
commit 8e8b47c
Show file tree

Hide file tree

Showing 18 changed files with 191 additions and 307 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md
@@ -56,16 +56,14 @@ The function has the following parameters:
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
 -   **stride**: index increment for `x`.
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to access every other element in `x`,
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access 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 N = floor( x.length / 2 );
 
-var v = sapxsumkbn2( N, 5.0, x, 2 );
+var v = sapxsumkbn2( 4, 5.0, x, 2 );
 // returns 25.0
 ```
 
@@ -75,14 +73,11 @@ 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' );
 
 var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var N = floor( x0.length / 2 );
-
-var v = sapxsumkbn2( N, 5.0, x1, 2 );
+var v = sapxsumkbn2( 4, 5.0, x1, 2 );
 // returns 25.0
 ```
 
@@ -108,12 +103,10 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 
 ```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 N = floor( x.length / 2 );
 
-var v = sapxsumkbn2.ndarray( N, 5.0, x, 2, 1 );
+var v = sapxsumkbn2.ndarray( 4, 5.0, x, 2, 1 );
 // returns 25.0
 ```
 
@@ -138,18 +131,11 @@ var v = sapxsumkbn2.ndarray( N, 5.0, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-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 sapxsumkbn2 = require( '@stdlib/blas/ext/base/sapxsumkbn2' );
 
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = round( randu()*100.0 );
-}
+var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ));
 console.log( x );
 
 var v = sapxsumkbn2( x.length, 5.0, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.js
@@ -21,14 +21,19 @@
 // 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var sapxsumkbn2 = require( './../lib/sapxsumkbn2.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -100.0, 100.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +44,7 @@ var sapxsumkbn2 = require( './../lib/sapxsumkbn2.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.native.js
@@ -22,10 +22,10 @@
 
 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,7 @@ var sapxsumkbn2 = tryRequire( resolve( __dirname, './../lib/sapxsumkbn2.native.j
 var opts = {
 	'skip': ( sapxsumkbn2 instanceof Error )
 };
+var rand = uniform( -100.0, 100.0 );
 
 
 // FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.ndarray.js
@@ -21,14 +21,19 @@
 // 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var sapxsumkbn2 = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -100.0, 100.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +44,7 @@ var sapxsumkbn2 = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/benchmark/benchmark.ndarray.native.js
@@ -22,10 +22,10 @@
 
 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,7 @@ var sapxsumkbn2 = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' )
 var opts = {
 	'skip': ( sapxsumkbn2 instanceof Error )
 };
+var rand = uniform( -100.0, 100.0 );
 
 
 // FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/docs/repl.txt
@@ -4,8 +4,8 @@
     element and computes the sum using a second-order iterative Kahan–Babuška
     algorithm.
 
-    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 a typed
     array view.
@@ -40,19 +40,16 @@
 
     // Using `N` and `stride` parameters:
     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > var stride = 2;
-    > {{alias}}( N, 5.0, x, stride )
+    > {{alias}}( 3, 5.0, x, 2 )
     16.0
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > stride = 2;
-    > {{alias}}( N, 5.0, x1, stride )
+    > {{alias}}( 3, 5.0, x1, 2 )
     14.0
 
+
 {{alias}}.ndarray( N, alpha, x, stride, offset )
     Adds a constant to each single-precision floating-point strided array
     element and computes the sum using a second-order iterative Kahan–Babuška
@@ -92,9 +89,8 @@
     16.0
 
     // Using offset parameter:
-    > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, 5.0, x, 2, 1 )
+    > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
+    > {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
     14.0
 
     See Also

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/examples/index.js
@@ -18,18 +18,11 @@
 
 '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 sapxsumkbn2 = require( './../lib' );
 
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-	x[ i ] = round( randu()*100.0 );
-}
+var x = filledarrayBy( 10, 'float32', discreteUniform( -100.0, 100.0 ) );
 console.log( x );
 
 var v = sapxsumkbn2( x.length, 5.0, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/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 ] ); }")',
     ],
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/lib/index.js
@@ -28,20 +28,17 @@
 * var sapxsumkbn2 = require( '@stdlib/blas/ext/base/sapxsumkbn2' );
 *
 * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-* var N = x.length;
 *
-* var v = sapxsumkbn2( N, 5.0, x, 1 );
+* var v = sapxsumkbn2( 3, 5.0, x, 1 );
 * // returns 16.0
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 * var sapxsumkbn2 = require( '@stdlib/blas/ext/base/sapxsumkbn2' );
 *
 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
-* var N = floor( x.length / 2 );
 *
-* var v = sapxsumkbn2.ndarray( N, 5.0, x, 2, 1 );
+* var v = sapxsumkbn2.ndarray( 4, 5.0, x, 2, 1 );
 * // returns 25.0
 */
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/lib/ndarray.js
@@ -46,12 +46,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
 *
 * @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 N = floor( x.length / 2 );
 *
-* var v = sapxsumkbn2( N, 5.0, x, 2, 1 );
+* var v = sapxsumkbn2( 4, 5.0, x, 2, 1 );
 * // returns 25.0
 */
 function sapxsumkbn2( N, alpha, x, stride, offset ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/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( './sapxsumkbn2.native.js' );
 
 
@@ -38,20 +39,16 @@ var addon = require( './sapxsumkbn2.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 N = floor( x.length / 2 );
 *
-* var v = sapxsumkbn2( N, 5.0, x, 2, 1 );
+* var v = sapxsumkbn2( 4, 5.0, x, 2, 1 );
 * // returns 25.0
 */
 function sapxsumkbn2( N, alpha, x, stride, offset ) {
 	var view;
-	if ( stride < 0 ) {
-		offset += (N-1) * stride;
-	}
-	view = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len
+	offset = minViewBufferIndex( N, stride, offset );
+	view = offsetView( x, offset );
 	return addon( N, alpha, view, stride );
 }