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

… conventions PR-URL: #1733 Closes: #1531 Ref: #1152 --------- Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Apr 17, 2024 · 326479a · 326479a · stdlib-bot · Apr 17, 2024
1 parent ebd3878
commit 326479a
Show file tree

Hide file tree

Showing 24 changed files with 217 additions and 735 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/snansumors/README.md
@@ -54,16 +54,17 @@ The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
--   **stride**: index increment for `x`.
+-   **stride**: index increment for the strided array.
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum of every other element in `x`,
+The `N` and `stride` parameters determine which elements in the strided array are 
+accessed at runtime. For example, to compute the sum of every other element in 
+the strided array.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float32Array( [ 1.0, 2.0, NaN, -7.0, NaN, 3.0, 4.0, 2.0 ] );
-var N = floor( x.length / 2 );
+var N = 4;
 
 var v = snansumors( N, x, 2 );
 // returns 5.0
@@ -75,14 +76,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, NaN, -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 = snansumors( N, x1, 2 );
+var v = snansumors( 4, x1, 2 );
 // returns 5.0
 ```
 
@@ -108,12 +106,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, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
-var N = floor( x.length / 2 );
 
-var v = snansumors.ndarray( N, x, 2, 1 );
+var v = snansumors.ndarray( 4, x, 2, 1 );
 // returns 5.0
 ```
 
@@ -139,22 +135,19 @@ var v = snansumors.ndarray( N, 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' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var snansumors = require( '@stdlib/blas/ext/base/snansumors' );
 
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    if ( randu() < 0.2 ) {
-        x[ i ] = NaN;
-    } else {
-        x[ i ] = round( randu()*100.0 );
+function rand() {
+    if ( bernoulli( 0.7 ) > 0 ) {
+        return discreteUniform( 0, 100 );
     }
+    return NaN;
 }
+
+var x = filledarrayBy( 10, 'float32', rand );
 console.log( x );
 
 var v = snansumors( x.length, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.js
@@ -21,10 +21,11 @@
 // 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 Float32Array = require( '@stdlib/array/float32' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var pkg = require( './../package.json' ).name;
 var snansumors = require( './../lib/snansumors.js' );
 
@@ -39,18 +40,15 @@ var snansumors = require( './../lib/snansumors.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
+	var x = filledarrayBy( len, 'float32', rand );
+	return benchmark;
 
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
+	function rand() {
+		if ( bernoulli( 0.8 ) > 0 ) {
+			return uniform( -10.0, 10.0 );
 		}
+		return NaN;
 	}
-	return benchmark;
 
 	function benchmark( b ) {
 		var v;

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.native.js
@@ -22,10 +22,11 @@
 
 var resolve = require( 'path' ).resolve;
 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 Float32Array = require( '@stdlib/array/float32' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -48,18 +49,15 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
+	var x = filledarrayBy( len, 'float32', rand );
+	return benchmark;
 
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
+	function rand() {
+		if ( bernoulli( 0.8 ) > 0 ) {
+			return uniform( -10.0, 10.0 );
 		}
+		return NaN;
 	}
-	return benchmark;
 
 	function benchmark( b ) {
 		var v;

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.ndarray.js
@@ -21,10 +21,11 @@
 // 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 Float32Array = require( '@stdlib/array/float32' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var pkg = require( './../package.json' ).name;
 var snansumors = require( './../lib/ndarray.js' );
 
@@ -39,18 +40,16 @@ var snansumors = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
+	var x = filledarrayBy( len, 'float32', rand );
+
+	return benchmark;
 
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
+	function rand() {
+		if ( bernoulli( 0.8 ) > 0 ) {
+			return uniform( -10.0, 10.0 );
 		}
+		return NaN;
 	}
-	return benchmark;
 
 	function benchmark( b ) {
 		var v;

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/benchmark/benchmark.ndarray.native.js
@@ -22,10 +22,11 @@
 
 var resolve = require( 'path' ).resolve;
 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 Float32Array = require( '@stdlib/array/float32' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -48,18 +49,16 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
+	var x = filledarrayBy( len, 'float32', rand );
+
+	return benchmark;
 
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
+	function rand() {
+		if ( bernoulli( 0.8 ) > 0 ) {
+			return uniform( -10.0, 10.0 );
 		}
+		return NaN;
 	}
-	return benchmark;
 
 	function benchmark( b ) {
 		var v;

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/snansumors/docs/repl.txt
@@ -3,8 +3,8 @@
     Computes the sum of single-precision floating-point strided array elements,
     ignoring `NaN` values and using ordinary recursive summation.
 
-    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.
@@ -36,19 +36,20 @@
 
     // Using `N` and `stride` parameters:
     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
+    > var N = 4;
     > var stride = 2;
     > {{alias}}( N, x, stride )
     1.0
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
+    > N = 4;
     > stride = 2;
     > {{alias}}( N, x1, stride )
     -1.0
 
+
 {{alias}}.ndarray( N, x, stride, offset )
     Computes the sum of single-precision floating-point strided array elements,
     ignoring `NaN` values and using ordinary recursive summation and alternative
@@ -86,7 +87,7 @@
 
     // Using offset parameter:
     > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
+    > var N = 4;
     > {{alias}}.ndarray( N, x, 2, 1 )
     -1.0
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/examples/index.js
@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2024 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.
@@ -18,22 +18,19 @@
 
 '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' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var snansumors = require( './../lib' );
 
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-	if ( randu() < 0.2 ) {
-		x[ i ] = NaN;
-	} else {
-		x[ i ] = round( randu()*100.0 );
+function rand() {
+	if ( bernoulli( 0.7 ) > 0 ) {
+		return discreteUniform( 0, 100 );
 	}
+	return NaN;
 }
+
+var x = filledarrayBy( 10, 'float32', rand );
 console.log( x );
 
 var v = snansumors( x.length, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/snansumors/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/snansumors/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/lib/index.js
@@ -35,13 +35,11 @@
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 * var snansumors = require( '@stdlib/blas/ext/base/snansumors' );
 *
 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
-* var N = floor( x.length / 2 );
 *
-* var v = snansumors.ndarray( N, x, 2, 1 );
+* var v = snansumors.ndarray( 5, x, 2, 1 );
 * // returns 5.0
 */
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/lib/ndarray.js
@@ -37,12 +37,10 @@ var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 *
 * @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, NaN, NaN ] );
-* var N = floor( x.length / 2 );
 *
-* var v = snansumors( N, x, 2, 1 );
+* var v = snansumors( 5, x, 2, 1 );
 * // returns 5.0
 */
 function snansumors( N, x, stride, offset ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/snansumors/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/snansumors/lib/ndarray.native.js
@@ -37,12 +37,10 @@ var addon = require( './snansumors.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, NaN, NaN ] );
-* var N = floor( x.length / 2 );
 *
-* var v = snansumors( N, x, 2, 1 );
+* var v = snansumors( 5, x, 2, 1 );
 * // returns 5.0
 */
 function snansumors( N, x, stride, offset ) {