refactor: update blas/ext/base/gnansumkbn to follow current project conventions

PR-URL: #4632
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: headlessNode

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

@@ -36,33 +36,29 @@ limitations under the License.
 var gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' );
 ```
 
-#### gnansumkbn( N, x, stride )
+#### gnansumkbn( N, x, strideX )
 
 Computes the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
 
 ```javascript
 var x = [ 1.0, -2.0, NaN, 2.0 ];
-var N = x.length;
 
-var v = gnansumkbn( N, x, 1 );
+var v = gnansumkbn( x.length, x, 1 );
 // returns 1.0
 ```
 
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
--   **stride**: index increment for `x`.
+-   **strideX**: stride length for `x`.
 
-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:
 
 ```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, NaN, NaN ];
-var N = floor( x.length / 2 );
 
-var v = gnansumkbn( N, x, 2 );
+var v = gnansumkbn( 5, x, 2 );
 // returns 5.0
 ```
 
@@ -72,42 +68,35 @@ 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' );
 
 var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var N = floor( x0.length / 2 );
-
-var v = gnansumkbn( N, x1, 2 );
+var v = gnansumkbn( 4, x1, 2 );
 // returns 5.0
 ```
 
-#### gnansumkbn.ndarray( N, x, stride, offset )
+#### gnansumkbn.ndarray( N, x, strideX, offsetX )
 
 Computes the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm and alternative indexing semantics.
 
 ```javascript
 var x = [ 1.0, -2.0, NaN, 2.0 ];
-var N = x.length;
 
-var v = gnansumkbn.ndarray( N, x, 1, 0 );
+var v = gnansumkbn.ndarray( x.length, x, 1, 0 );
 // returns 1.0
 ```
 
 The function has the following additional parameters:
 
--   **offset**: starting index for `x`.
+-   **offsetX**: starting index for `x`.
 
-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 element starting from the second 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, NaN, NaN ];
-var N = floor( x.length / 2 );
 
-var v = gnansumkbn.ndarray( N, x, 2, 1 );
+var v = gnansumkbn.ndarray( 5, x, 2, 1 );
 // returns 5.0
 ```
 
@@ -133,22 +122,19 @@ var v = gnansumkbn.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 Float64Array = require( '@stdlib/array/float64' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' );
 
-var x;
-var i;
-
-x = new Float64Array( 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, 'float64', rand );
 console.log( x );
 
 var v = gnansumkbn( x.length, x, 1 );

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

@@ -21,7 +21,9 @@
 // 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 pkg = require( './../package.json' ).name;
@@ -30,6 +32,19 @@ var gnansumkbn = require( './../lib/main.js' );
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.8 ) > 0 ) {
+		return uniform( -10.0, 10.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -38,17 +53,7 @@ var gnansumkbn = require( './../lib/main.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = [];
-	for ( i = 0; i < len; i++ ) {
-		if ( randu() < 0.2 ) {
-			x.push( NaN );
-		} else {
-			x.push( ( randu()*10.0 ) - 20.0 );
-		}
-	}
+	var x = filledarrayBy( len, 'generic', rand );
 	return benchmark;
 
 	function benchmark( b ) {

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

@@ -21,7 +21,9 @@
 // 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 pkg = require( './../package.json' ).name;
@@ -30,6 +32,19 @@ var gnansumkbn = require( './../lib/ndarray.js' );
 
 // FUNCTIONS //
 
+/**
+* Returns a random number.
+*
+* @private
+* @returns {number} random number
+*/
+function rand() {
+	if ( bernoulli( 0.8 ) > 0 ) {
+		return uniform( -10.0, 10.0 );
+	}
+	return NaN;
+}
+
 /**
 * Creates a benchmark function.
 *
@@ -38,17 +53,7 @@ var gnansumkbn = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = [];
-	for ( i = 0; i < len; i++ ) {
-		if ( randu() < 0.2 ) {
-			x.push( NaN );
-		} else {
-			x.push( ( randu()*10.0 ) - 20.0 );
-		}
-	}
+	var x = filledarrayBy( len, 'generic', rand );
 	return benchmark;
 
 	function benchmark( b ) {

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

@@ -1,10 +1,10 @@
 
-{{alias}}( N, x, stride )
+{{alias}}( N, x, strideX )
     Computes the sum of strided array elements, ignoring `NaN` values and using
     an improved 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.
@@ -19,8 +19,8 @@
     x: Array<number>|TypedArray
         Input array.
 
-    stride: integer
-        Index increment.
+    strideX: integer
+        Stride length.
 
     Returns
     -------
@@ -34,28 +34,25 @@
     > {{alias}}( x.length, x, 1 )
     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, NaN, NaN ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > var stride = 2;
-    > {{alias}}( N, x, stride )
+    > {{alias}}( 4, x, 2 )
     1.0
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
     > var x1 = new {{alias:@stdlib/array/float64}}( 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, 2 )
     -1.0
 
-{{alias}}.ndarray( N, x, stride, offset )
+
+{{alias}}.ndarray( N, x, strideX, offsetX )
     Computes the sum of strided array elements, ignoring `NaN` values and using
     an improved Kahan–Babuška algorithm and 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 parameter supports indexing semantics based on a starting
+    index.
 
     Parameters
     ----------
@@ -65,10 +62,10 @@
     x: Array<number>|TypedArray
         Input array.
 
-    stride: integer
-        Index increment.
+    strideX: integer
+        Stride length.
 
-    offset: integer
+    offsetX: integer
         Starting index.
 
     Returns
@@ -85,8 +82,7 @@
 
     // Using offset parameter:
     > var x = [ 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 )
+    > {{alias}}.ndarray( 4, x, 2, 1 )
     -1.0
 
     See Also

lib/node_modules/@stdlib/blas/ext/base/gnansumkbn/docs/types/index.d.ts

@@ -31,7 +31,7 @@ interface Routine {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -40,15 +40,15 @@ interface Routine {
 	* var v = gnansumkbn( x.length, x, 1 );
 	* // returns 1.0
 	*/
-	( N: number, x: NumericArray, stride: number ): number;
+	( N: number, x: NumericArray, strideX: number ): number;
 
 	/**
 	* Computes the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm and alternative indexing semantics.
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
-	* @param offset - starting index
+	* @param strideX - stride length
+	* @param offsetX - starting index
 	* @returns sum
 	*
 	* @example
@@ -57,15 +57,15 @@ interface Routine {
 	* var v = gnansumkbn.ndarray( x.length, x, 1, 0 );
 	* // returns 1.0
 	*/
-	ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;
+	ndarray( N: number, x: NumericArray, strideX: number, offsetX: number ): number;
 }
 
 /**
 * Computes the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
 *
 * @param N - number of indexed elements
 * @param x - input array
-* @param stride - stride length
+* @param strideX - stride length
 * @returns sum
 *
 * @example

lib/node_modules/@stdlib/blas/ext/base/gnansumkbn/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 Float64Array = require( '@stdlib/array/float64' );
-var gnansumkbn = require( './../lib' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var bernoulli = require( '@stdlib/random/base/bernoulli' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' );
 
-var x;
-var i;
-
-x = new Float64Array( 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, 'float64', rand );
 console.log( x );
 
 var v = gnansumkbn( x.length, x, 1 );