refactor: update blas/ext/base/sdsnansum to follow current project convention

PR-URL: #1773
Closes: #1523

---------

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

Author: 3 people

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

@@ -2,7 +2,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.
@@ -44,28 +44,25 @@ Computes the sum of single-precision floating-point strided array elements, igno
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
-var N = x.length;
 
-var v = sdsnansum( N, x, 1 );
+var v = sdsnansum( 4, x, 1 );
 // returns 1.0
 ```
 
 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 v = sdsnansum( N, x, 2 );
+var v = sdsnansum( 4, x, 2 );
 // returns 5.0
 ```
 
@@ -75,14 +72,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 = sdsnansum( N, x1, 2 );
+var v = sdsnansum( 4, x1, 2 );
 // returns 5.0
 ```
 
@@ -102,18 +96,16 @@ var v = sdsnansum.ndarray( N, x, 1, 0 );
 
 The function has the following additional parameters:
 
--   **offset**: starting index for `x`.
+-   **offset**: starting index for the strided array.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other value in `x` starting from the second value
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other value in the strided array starting from the second value
 
 ```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 = sdsnansum.ndarray( N, x, 2, 1 );
+var v = sdsnansum.ndarray( 4, x, 2, 1 );
 // returns 5.0
 ```
 
@@ -139,22 +131,19 @@ var v = sdsnansum.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 sdsnansum = require( '@stdlib/blas/ext/base/sdsnansum' );
 
-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 randOrNan() {
+    if ( bernoulli() < 0.2 ) {
+        return NaN;
     }
+    return discreteUniform( 0, 100 );
 }
+
+var x = filledarrayBy( 10, 'float32', randOrNan );
 console.log( x );
 
 var v = sdsnansum( x.length, x, 1 );

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

@@ -21,16 +21,24 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+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 sdsnansum = require( './../lib/sdsnansum.js' );
 
 
 // FUNCTIONS //
 
+function randOrNan() {
+	if ( bernoulli() < 0.2 ) {
+		return NaN;
+	}
+	return uniform( -20.0, -10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -39,17 +47,7 @@ var sdsnansum = require( './../lib/sdsnansum.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	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;
-		}
-	}
+	var x = filledarrayBy( len, 'float32', randOrNan );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/sdsnansum/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 uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+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;
 
@@ -40,6 +41,13 @@ var opts = {
 
 // FUNCTIONS //
 
+function randOrNan() {
+	if ( bernoulli() < 0.2 ) {
+		return NaN;
+	}
+	return uniform( -20.0, -10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -48,17 +56,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++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
-		}
-	}
+	var x = filledarrayBy( len, 'float32', randOrNan );
 	return benchmark;
 
 	function benchmark( b ) {

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

@@ -21,16 +21,24 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+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 sdsnansum = require( './../lib/ndarray.js' );
 
 
 // FUNCTIONS //
 
+function randOrNan() {
+	if ( bernoulli() < 0.2 ) {
+		return NaN;
+	}
+	return uniform( -20.0, -10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -39,17 +47,7 @@ var sdsnansum = 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++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
-		}
-	}
+	var x = filledarrayBy( len, 'float32', randOrNan );
 	return benchmark;
 
 	function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/sdsnansum/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 uniform = require( '@stdlib/random/base/uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+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;
 
@@ -40,6 +41,13 @@ var opts = {
 
 // FUNCTIONS //
 
+function randOrNan() {
+	if ( bernoulli() < 0.2 ) {
+		return NaN;
+	}
+	return uniform( -20.0, -10.0 );
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -48,17 +56,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++ ) {
-		if ( randu() < 0.2 ) {
-			x[ i ] = NaN;
-		} else {
-			x[ i ] = ( randu()*10.0 ) - 20.0;
-		}
-	}
+	var x = filledarrayBy( len, 'float32', randOrNan );
 	return benchmark;
 
 	function benchmark( b ) {

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

@@ -1,9 +1,10 @@
 
 {{alias}}( N, x, stride )
-    Computes the sum of single-precision floating-point strided array elements,
-    ignoring `NaN` values and using extended accumulation.
+    Computes the sum of single-precision floating-point strided array
+    elements, ignore `NaN` values and using extended accumulation.
 
-    The `N` and `stride` parameters determine which elements in `x` are accessed
+    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
@@ -36,19 +37,18 @@
 
     // 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 stride = 2;
-    > {{alias}}( N, x, stride )
+    > {{alias}}( 4, 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 );
     > stride = 2;
-    > {{alias}}( N, x1, stride )
+    > {{alias}}( 4, 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 extended accumulation and alternative
@@ -85,9 +85,8 @@
     1.0
 
     // 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 );
-    > {{alias}}.ndarray( N, x, 2, 1 )
+    > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
+    > {{alias}}.ndarray( 4, x, 2, 1 )
     -1.0
 
     See Also

lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/index.js

@@ -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 sdsnansum = 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 randOrNan() {
+	if ( bernoulli() < 0.2 ) {
+		return NaN;
 	}
+	return discreteUniform( 0, 100 );
 }
+
+var x = filledarrayBy( 10, 'float32', randOrNan );
 console.log( x );
 
 var v = sdsnansum( x.length, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/sdsnansum/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 ] ); }")',
     ],