Skip to content

Commit a9016c6

Browse files
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]>
1 parent 846f9b8 commit a9016c6

18 files changed

+197
-323
lines changed

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/README.md

+9-29
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ Computes the sum of double-precision floating-point strided array elements, igno
4444
var Float64Array = require( '@stdlib/array/float64' );
4545

4646
var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
47-
var N = x.length;
4847

49-
var v = dnansumkbn( N, x, 1 );
48+
var v = dnansumkbn( 4, x, 1 );
5049
// returns 1.0
5150
```
5251

@@ -56,16 +55,14 @@ The function has the following parameters:
5655
- **x**: input [`Float64Array`][@stdlib/array/float64].
5756
- **stride**: index increment for `x`.
5857

59-
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`,
58+
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`,
6059

6160
```javascript
6261
var Float64Array = require( '@stdlib/array/float64' );
63-
var floor = require( '@stdlib/math/base/special/floor' );
6462

6563
var x = new Float64Array( [ 1.0, 2.0, NaN, -7.0, NaN, 3.0, 4.0, 2.0 ] );
66-
var N = floor( x.length / 2 );
6764

68-
var v = dnansumkbn( N, x, 2 );
65+
var v = dnansumkbn( 4, x, 2 );
6966
// returns 5.0
7067
```
7168

@@ -75,14 +72,11 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7572

7673
```javascript
7774
var Float64Array = require( '@stdlib/array/float64' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7975

8076
var x0 = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
8177
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8278

83-
var N = floor( x0.length / 2 );
84-
85-
var v = dnansumkbn( N, x1, 2 );
79+
var v = dnansumkbn( 4, x1, 2 );
8680
// returns 5.0
8781
```
8882

@@ -94,9 +88,8 @@ Computes the sum of double-precision floating-point strided array elements, igno
9488
var Float64Array = require( '@stdlib/array/float64' );
9589

9690
var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
97-
var N = x.length;
9891

99-
var v = dnansumkbn.ndarray( N, x, 1, 0 );
92+
var v = dnansumkbn.ndarray( 4, x, 1, 0 );
10093
// returns 1.0
10194
```
10295

@@ -108,12 +101,10 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
108101

109102
```javascript
110103
var Float64Array = require( '@stdlib/array/float64' );
111-
var floor = require( '@stdlib/math/base/special/floor' );
112104

113105
var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
114-
var N = floor( x.length / 2 );
115106

116-
var v = dnansumkbn.ndarray( N, x, 2, 1 );
107+
var v = dnansumkbn.ndarray( 4, x, 2, 1 );
117108
// returns 5.0
118109
```
119110

@@ -138,22 +129,11 @@ var v = dnansumkbn.ndarray( N, x, 2, 1 );
138129
<!-- eslint no-undef: "error" -->
139130

140131
```javascript
141-
var randu = require( '@stdlib/random/base/randu' );
142-
var round = require( '@stdlib/math/base/special/round' );
143-
var Float64Array = require( '@stdlib/array/float64' );
132+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
133+
var filledarrayBy = require( '@stdlib/array/filled-by' );
144134
var dnansumkbn = require( '@stdlib/blas/ext/base/dnansumkbn' );
145135

146-
var x;
147-
var i;
148-
149-
x = new Float64Array( 10 );
150-
for ( i = 0; i < x.length; i++ ) {
151-
if ( randu() < 0.2 ) {
152-
x[ i ] = NaN;
153-
} else {
154-
x[ i ] = round( randu()*100.0 );
155-
}
156-
}
136+
var x = filledarrayBy( 10, 'float64', discreteUniform( 0, 100 ) );
157137
console.log( x );
158138

159139
var v = dnansumkbn( x.length, x, 1 );

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.js

+8-13
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,19 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2828
var pkg = require( './../package.json' ).name;
2929
var dnansumkbn = require( './../lib/dnansumkbn.js' );
3030

3131

32+
// VARIABLES //
33+
34+
var rand = uniform( -10.0, 10.0 );
35+
36+
3237
// FUNCTIONS //
3338

3439
/**
@@ -39,17 +44,7 @@ var dnansumkbn = require( './../lib/dnansumkbn.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float64Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
if ( randu() < 0.2 ) {
48-
x[ i ] = NaN;
49-
} else {
50-
x[ i ] = ( randu()*10.0 ) - 20.0;
51-
}
52-
}
47+
var x = filledarrayBy( len, 'float64', rand );
5348
return benchmark;
5449

5550
function benchmark( b ) {

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.native.js

+4-13
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2627
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

@@ -36,6 +36,7 @@ var dnansumkbn = tryRequire( resolve( __dirname, './../lib/dnansumkbn.native.js'
3636
var opts = {
3737
'skip': ( dnansumkbn instanceof Error )
3838
};
39+
var rand = uniform( -10.0, 10.0 );
3940

4041

4142
// FUNCTIONS //
@@ -48,17 +49,7 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float64Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
if ( randu() < 0.2 ) {
57-
x[ i ] = NaN;
58-
} else {
59-
x[ i ] = ( randu()*10.0 ) - 20.0;
60-
}
61-
}
52+
var x = filledarrayBy( len, 'float64', rand );
6253
return benchmark;
6354

6455
function benchmark( b ) {

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.ndarray.js

+8-13
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,19 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2828
var pkg = require( './../package.json' ).name;
2929
var dnansumkbn = require( './../lib/ndarray.js' );
3030

3131

32+
// VARIABLES //
33+
34+
var rand = uniform( -10.0, 10.0 );
35+
36+
3237
// FUNCTIONS //
3338

3439
/**
@@ -39,17 +44,7 @@ var dnansumkbn = require( './../lib/ndarray.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float64Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
if ( randu() < 0.2 ) {
48-
x[ i ] = NaN;
49-
} else {
50-
x[ i ] = ( randu()*10.0 ) - 20.0;
51-
}
52-
}
47+
var x = filledarrayBy( len, 'float64', rand );
5348
return benchmark;
5449

5550
function benchmark( b ) {

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/benchmark/benchmark.ndarray.native.js

+4-13
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2627
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

@@ -36,6 +36,7 @@ var dnansumkbn = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' )
3636
var opts = {
3737
'skip': ( dnansumkbn instanceof Error )
3838
};
39+
var rand = uniform( -10.0, 10.0 );
3940

4041

4142
// FUNCTIONS //
@@ -48,17 +49,7 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float64Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
if ( randu() < 0.2 ) {
57-
x[ i ] = NaN;
58-
} else {
59-
x[ i ] = ( randu()*10.0 ) - 20.0;
60-
}
61-
}
52+
var x = filledarrayBy( len, 'float64', rand );
6253
return benchmark;
6354

6455
function benchmark( b ) {

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/docs/repl.txt

+6-10
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Computes the sum of double-precision floating-point strided array elements,
44
ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
55

6-
The `N` and `stride` parameters determine which elements in `x` are accessed
7-
at runtime.
6+
The `N` and stride parameters determine which elements in the strided
7+
array are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use a typed
1010
array view.
@@ -36,19 +36,16 @@
3636

3737
// Using `N` and `stride` parameters:
3838
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );
39-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
40-
> var stride = 2;
41-
> {{alias}}( N, x, stride )
39+
> {{alias}}( 4, x, 2 )
4240
1.0
4341

4442
// Using view offsets:
4543
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
4644
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
47-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
48-
> stride = 2;
49-
> {{alias}}( N, x1, stride )
45+
> {{alias}}( 4, x1, 2 )
5046
-1.0
5147

48+
5249
{{alias}}.ndarray( N, x, stride, offset )
5350
Computes the sum of double-precision floating-point strided array elements,
5451
ignoring `NaN` values and using an improved Kahan–Babuška algorithm and
@@ -86,8 +83,7 @@
8683

8784
// Using offset parameter:
8885
> var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
89-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
90-
> {{alias}}.ndarray( N, x, 2, 1 )
86+
> {{alias}}.ndarray( 4, x, 2, 1 )
9187
-1.0
9288

9389
See Also

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/examples/index.js

+3-14
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,11 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
23-
var Float64Array = require( '@stdlib/array/float64' );
21+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
22+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2423
var dnansumkbn = require( './../lib' );
2524

26-
var x;
27-
var i;
28-
29-
x = new Float64Array( 10 );
30-
for ( i = 0; i < x.length; i++ ) {
31-
if ( randu() < 0.2 ) {
32-
x[ i ] = NaN;
33-
} else {
34-
x[ i ] = round( randu()*100.0 );
35-
}
36-
}
25+
var x = filledarrayBy( 10, 'float64', discreteUniform( 0.0, 100.0 ) );
3726
console.log( x );
3827

3928
var v = dnansumkbn( x.length, x, 1 );

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/include.gypi

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
# Source files:
3838
'src_files': [
39-
'<(src_dir)/addon.cpp',
39+
'<(src_dir)/addon.c',
4040
'<!@(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 ] ); }")',
4141
],
4242

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/lib/index.js

+2-5
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,17 @@
2828
* var dnansumkbn = require( '@stdlib/blas/ext/base/dnansumkbn' );
2929
*
3030
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
31-
* var N = x.length;
3231
*
33-
* var v = dnansumkbn( N, x, 1 );
32+
* var v = dnansumkbn( 4, x, 1 );
3433
* // returns 1.0
3534
*
3635
* @example
3736
* var Float64Array = require( '@stdlib/array/float64' );
38-
* var floor = require( '@stdlib/math/base/special/floor' );
3937
* var dnansumkbn = require( '@stdlib/blas/ext/base/dnansumkbn' );
4038
*
4139
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
42-
* var N = floor( x.length / 2 );
4340
*
44-
* var v = dnansumkbn.ndarray( N, x, 2, 1 );
41+
* var v = dnansumkbn.ndarray( 5, x, 2, 1 );
4542
* // returns 5.0
4643
*/
4744

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnansumkbn/lib/ndarray.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
4545
*
4646
* @example
4747
* var Float64Array = require( '@stdlib/array/float64' );
48-
* var floor = require( '@stdlib/math/base/special/floor' );
4948
*
5049
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
51-
* var N = floor( x.length / 2 );
5250
*
53-
* var v = dnansumkbn( N, x, 2, 1 );
51+
* var v = dnansumkbn( 5, x, 2, 1 );
5452
* // returns 5.0
5553
*/
5654
function dnansumkbn( N, x, stride, offset ) {

0 commit comments

Comments
 (0)