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

… conventions PR-URL: #1989 Closes: #1484 --------- Signed-off-by: Suraj kumar <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Mar 26, 2024 · a9016c6 · a9016c6 · stdlib-bot · Mar 26, 2024
1 parent 846f9b8
commit a9016c6
Show file tree

Hide file tree

Showing 18 changed files with 197 additions and 323 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/README.md
@@ -44,9 +44,8 @@ Computes the sum of double-precision floating-point strided array elements, igno
 var Float64Array = require( '@stdlib/array/float64' );
 
 var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
-var N = x.length;
 
-var v = dnansumkbn( N, x, 1 );
+var v = dnansumkbn( 4, x, 1 );
 // returns 1.0
 ```
 
@@ -56,16 +55,14 @@ The function has the following parameters:
 - **x**: input [`Float64Array`][@stdlib/array/float64].
 - **stride**: index increment 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 arrays are accessed at runtime. For example, to compute the sum of every other element in `x`,
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float64Array( [ 1.0, 2.0, NaN, -7.0, NaN, 3.0, 4.0, 2.0 ] );
-var N = floor( x.length / 2 );
 
-var v = dnansumkbn( N, x, 2 );
+var v = dnansumkbn( 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 Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x0 = new Float64Array( [ 2.0, 1.0, NaN, -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 = dnansumkbn( N, x1, 2 );
+var v = dnansumkbn( 4, x1, 2 );
 // returns 5.0
 ```
 
@@ -94,9 +88,8 @@ Computes the sum of double-precision floating-point strided array elements, igno
 var Float64Array = require( '@stdlib/array/float64' );
 
 var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
-var N = x.length;
 
-var v = dnansumkbn.ndarray( N, x, 1, 0 );
+var v = dnansumkbn.ndarray( 4, x, 1, 0 );
 // returns 1.0
 ```
 
@@ -108,12 +101,10 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
-var N = floor( x.length / 2 );
 
-var v = dnansumkbn.ndarray( N, x, 2, 1 );
+var v = dnansumkbn.ndarray( 4, x, 2, 1 );
 // returns 5.0
 ```
 
@@ -138,22 +129,11 @@ var v = dnansumkbn.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' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var dnansumkbn = require( '@stdlib/blas/ext/base/dnansumkbn' );
 
-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 );
- }
-}
+var x = filledarrayBy( 10, 'float64', discreteUniform( 0, 100 ) );
 console.log( x );
 
 var v = dnansumkbn( x.length, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/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 Float64Array = require( '@stdlib/array/float64' );
 var pkg = require( './../package.json' ).name;
 var dnansumkbn = require( './../lib/dnansumkbn.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -10.0, 10.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,17 +44,7 @@ var dnansumkbn = require( './../lib/dnansumkbn.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
- var x;
- var i;
-
- x = new Float64Array( 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, 'float64', rand );
  return benchmark;
 
  function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/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 Float64Array = require( '@stdlib/array/float64' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,7 @@ var dnansumkbn = tryRequire( resolve( __dirname, './../lib/dnansumkbn.native.js'
 var opts = {
  'skip': ( dnansumkbn instanceof Error )
 };
+var rand = uniform( -10.0, 10.0 );
 
 
 // FUNCTIONS //
@@ -48,17 +49,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
- var x;
- var i;
-
- x = new Float64Array( 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, 'float64', rand );
  return benchmark;
 
  function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/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 Float64Array = require( '@stdlib/array/float64' );
 var pkg = require( './../package.json' ).name;
 var dnansumkbn = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -10.0, 10.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,17 +44,7 @@ var dnansumkbn = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
- var x;
- var i;
-
- x = new Float64Array( 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, 'float64', rand );
  return benchmark;
 
  function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/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 Float64Array = require( '@stdlib/array/float64' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,7 @@ var dnansumkbn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' )
 var opts = {
  'skip': ( dnansumkbn instanceof Error )
 };
+var rand = uniform( -10.0, 10.0 );
 
 
 // FUNCTIONS //
@@ -48,17 +49,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
- var x;
- var i;
-
- x = new Float64Array( 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, 'float64', rand );
  return benchmark;
 
  function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/docs/repl.txt
@@ -3,8 +3,8 @@
  Computes the sum of double-precision floating-point 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.
@@ -36,19 +36,16 @@
 
  // Using `N` and `stride` parameters:
  > x = new {{alias:@stdlib/array/float64}}( [ -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 )
  Computes the sum of double-precision floating-point strided array elements,
  ignoring `NaN` values and using an improved Kahan–Babuška algorithm and
@@ -86,8 +83,7 @@
 
  // Using offset parameter:
  > var x = new {{alias:@stdlib/array/float64}}( [ 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

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/examples/index.js
@@ -18,22 +18,11 @@
 
 'use strict';
 
-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' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var dnansumkbn = require( './../lib' );
 
-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 );
- }
-}
+var x = filledarrayBy( 10, 'float64', discreteUniform( 0.0, 100.0 ) );
 console.log( x );
 
 var v = dnansumkbn( x.length, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/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/dnansumkbn/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/lib/index.js
@@ -28,20 +28,17 @@
 * var dnansumkbn = require( '@stdlib/blas/ext/base/dnansumkbn' );
 *
 * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
-* var N = x.length;
 *
-* var v = dnansumkbn( N, x, 1 );
+* var v = dnansumkbn( 4, x, 1 );
 * // returns 1.0
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 * var dnansumkbn = require( '@stdlib/blas/ext/base/dnansumkbn' );
 *
 * var x = new Float64Array( [ 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 = dnansumkbn.ndarray( N, x, 2, 1 );
+* var v = dnansumkbn.ndarray( 5, x, 2, 1 );
 * // returns 5.0
 */
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/lib/ndarray.js
@@ -45,12 +45,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var floor = require( '@stdlib/math/base/special/floor' );
 *
 * var x = new Float64Array( [ 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 = dnansumkbn( N, x, 2, 1 );
+* var v = dnansumkbn( 5, x, 2, 1 );
 * // returns 5.0
 */
 function dnansumkbn( N, x, stride, offset ) {