Skip to content

Commit f0cd892

Browse files
refactor: update blas/ext/base/dnanasum to follow current project conventions
PR-URL: #1924 Closes: #1476 Ref: #1152 --------- Signed-off-by: Raunak Kumar Gupta <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Reviewed-by: Pranav Goswami <[email protected]>
1 parent 430a72b commit f0cd892

21 files changed

+225
-314
lines changed

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

+15-25
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,14 @@ The function has the following parameters:
7171
- **x**: input [`Float64Array`][@stdlib/array/float64].
7272
- **stride**: index increment for `x`.
7373

74-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum of absolute values ([_L1_ norm][l1norm]) every other element in `x`,
74+
The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of absolute values ([_L1_ norm][l1norm]) every other element in the strided array,
7575

7676
```javascript
7777
var Float64Array = require( '@stdlib/array/float64' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7978

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

83-
var v = dnanasum( N, x, 2 );
81+
var v = dnanasum( 4, x, 2 );
8482
// returns 5.0
8583
```
8684

@@ -90,14 +88,11 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9088

9189
```javascript
9290
var Float64Array = require( '@stdlib/array/float64' );
93-
var floor = require( '@stdlib/math/base/special/floor' );
9491

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

98-
var N = floor( x0.length / 2 );
99-
100-
var v = dnanasum( N, x1, 2 );
95+
var v = dnanasum( 4, x1, 2 );
10196
// returns 9.0
10297
```
10398

@@ -109,26 +104,23 @@ Computes the sum of absolute values ([_L1_ norm][l1norm]) of double-precision fl
109104
var Float64Array = require( '@stdlib/array/float64' );
110105

111106
var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
112-
var N = x.length;
113107

114-
var v = dnanasum.ndarray( N, x, 1, 0 );
108+
var v = dnanasum.ndarray( 4, x, 1, 0 );
115109
// returns 5.0
116110
```
117111

118112
The function has the following additional parameters:
119113

120114
- **offset**: starting index for `x`.
121115

122-
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 absolute values ([_L1_ norm][l1norm]) every other value in `x` starting from the second value
116+
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 absolute values ([_L1_ norm][l1norm]) every other value in the strided array starting from the second value
123117

124118
```javascript
125119
var Float64Array = require( '@stdlib/array/float64' );
126-
var floor = require( '@stdlib/math/base/special/floor' );
127120

128121
var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
129-
var N = floor( x.length / 2 );
130122

131-
var v = dnanasum.ndarray( N, x, 2, 1 );
123+
var v = dnanasum.ndarray( 4, x, 2, 1 );
132124
// returns 9.0
133125
```
134126

@@ -153,22 +145,20 @@ var v = dnanasum.ndarray( N, x, 2, 1 );
153145
<!-- eslint no-undef: "error" -->
154146

155147
```javascript
156-
var randu = require( '@stdlib/random/base/randu' );
157-
var round = require( '@stdlib/math/base/special/round' );
148+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
149+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
150+
var filledarrayBy = require( '@stdlib/array/filled-by' );
158151
var Float64Array = require( '@stdlib/array/float64' );
159152
var dnanasum = require( '@stdlib/blas/ext/base/dnanasum' );
160153

161-
var x;
162-
var i;
163-
164-
x = new Float64Array( 10 );
165-
for ( i = 0; i < x.length; i++ ) {
166-
if ( randu() < 0.2 ) {
167-
x[ i ] = NaN;
168-
} else {
169-
x[ i ] = round( randu()*100.0 );
154+
function rand() {
155+
if ( bernoulli( 0.8 ) > 0 ) {
156+
return discreteUniform( 0, 100 );
170157
}
158+
return NaN;
171159
}
160+
161+
var x = filledarrayBy( 10, 'float64', rand );
172162
console.log( x );
173163

174164
var v = dnanasum( x.length, x, 1 );

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
25+
var uniform = require( '@stdlib/random/base/uniform' );
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2527
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2628
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2829
var pkg = require( './../package.json' ).name;
2930
var dnanasum = require( './../lib/dnanasum.js' );
3031

@@ -39,18 +40,15 @@ var dnanasum = require( './../lib/dnanasum.js' );
3940
* @returns {Function} benchmark function
4041
*/
4142
function createBenchmark( len ) {
42-
var x;
43-
var i;
43+
var x = filledarrayBy( len, 'float64', rand );
44+
return benchmark;
4445

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()*20.0 ) - 10.0;
46+
function rand() {
47+
if ( bernoulli( 0.8 ) > 0 ) {
48+
return uniform( -10.0, 10.0 );
5149
}
50+
return NaN;
5251
}
53-
return benchmark;
5452

5553
function benchmark( b ) {
5654
var v;

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
26+
var uniform = require( '@stdlib/random/base/uniform' );
27+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2628
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2729
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
2930
var tryRequire = require( '@stdlib/utils/try-require' );
3031
var pkg = require( './../package.json' ).name;
3132

@@ -48,18 +49,15 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
52+
var x = filledarrayBy( len, 'float64', rand );
53+
return benchmark;
5354

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()*20.0 ) - 10.0;
55+
function rand() {
56+
if ( bernoulli( 0.8 ) > 0 ) {
57+
return uniform( -10.0, 10.0 );
6058
}
59+
return NaN;
6160
}
62-
return benchmark;
6361

6462
function benchmark( b ) {
6563
var v;

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
25+
var uniform = require( '@stdlib/random/base/uniform' );
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2527
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2628
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2829
var pkg = require( './../package.json' ).name;
2930
var dnanasum = require( './../lib/ndarray.js' );
3031

@@ -39,18 +40,15 @@ var dnanasum = require( './../lib/ndarray.js' );
3940
* @returns {Function} benchmark function
4041
*/
4142
function createBenchmark( len ) {
42-
var x;
43-
var i;
43+
var x = filledarrayBy( len, 'float64', rand );
44+
return benchmark;
4445

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()*20.0 ) - 10.0;
46+
function rand() {
47+
if ( bernoulli( 0.8 ) > 0 ) {
48+
return uniform( -10.0, 10.0 );
5149
}
50+
return NaN;
5251
}
53-
return benchmark;
5452

5553
function benchmark( b ) {
5654
var v;

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
26+
var uniform = require( '@stdlib/random/base/uniform' );
27+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2628
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2729
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float64Array = require( '@stdlib/array/float64' );
2930
var tryRequire = require( '@stdlib/utils/try-require' );
3031
var pkg = require( './../package.json' ).name;
3132

@@ -48,18 +49,15 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
52+
var x = filledarrayBy( len, 'float64', rand );
53+
return benchmark;
5354

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()*20.0 ) - 10.0;
55+
function rand() {
56+
if ( bernoulli( 0.8 ) > 0 ) {
57+
return uniform( -10.0, 10.0 );
6058
}
59+
return NaN;
6160
}
62-
return benchmark;
6361

6462
function benchmark( b ) {
6563
var v;

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

+6-11
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Computes the sum of absolute values (L1 norm) of double-precision floating-
44
point strided array elements, ignoring `NaN` values.
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
5.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
5.0
5147

48+
5249
{{alias}}.ndarray( N, x, stride, offset )
5350
Computes the sum of absolute values (L1 norm) of double-precision floating-
5451
point strided array elements, ignoring `NaN` values and using alternative
@@ -86,10 +83,8 @@
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
5.0
9288

9389
See Also
9490
--------
95-

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

+9-12
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,19 @@
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 bernoulli = require( '@stdlib/random/base/bernoulli' );
22+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
23+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2424
var dnanasum = require( './../lib' );
2525

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 );
26+
function rand() {
27+
if ( bernoulli( 0.8 ) > 0 ) {
28+
return discreteUniform( 0, 100 );
3529
}
30+
return NaN;
3631
}
32+
33+
var x = filledarrayBy( 10, 'float64', rand );
3734
console.log( x );
3835

3936
var v = dnanasum( x.length, x, 1 );

Diff for: lib/node_modules/@stdlib/blas/ext/base/dnanasum/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/dnanasum/lib/dnanasum.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ var dnanasumors = require( '@stdlib/blas/ext/base/dnanasumors' );
3737
* var Float64Array = require( '@stdlib/array/float64' );
3838
*
3939
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
40-
* var N = x.length;
4140
*
42-
* var v = dnanasum( N, x, 1 );
41+
* var v = dnanasum( 4, x, 1 );
4342
* // returns 5.0
4443
*/
4544
function dnanasum( N, x, stride ) {

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ var addon = require( './../src/addon.node' );
3737
* var Float64Array = require( '@stdlib/array/float64' );
3838
*
3939
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
40-
* var N = x.length;
4140
*
42-
* var v = dnanasum( N, x, 1 );
41+
* var v = dnanasum( 4, x, 1 );
4342
* // returns 5.0
4443
*/
4544
function dnanasum( N, x, stride ) {

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

+2-5
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,17 @@
2828
* var dnanasum = require( '@stdlib/blas/ext/base/dnanasum' );
2929
*
3030
* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
31-
* var N = x.length;
3231
*
33-
* var v = dnanasum( N, x, 1 );
32+
* var v = dnanasum( 4, x, 1 );
3433
* // returns 5.0
3534
*
3635
* @example
3736
* var Float64Array = require( '@stdlib/array/float64' );
38-
* var floor = require( '@stdlib/math/base/special/floor' );
3937
* var dnanasum = require( '@stdlib/blas/ext/base/dnanasum' );
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 = dnanasum.ndarray( N, x, 2, 1 );
41+
* var v = dnanasum.ndarray( 5, x, 2, 1 );
4542
* // returns 9.0
4643
*/
4744

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ var dnanasumors = require( '@stdlib/blas/ext/base/dnanasumors' ).ndarray;
3939
* var floor = require( '@stdlib/math/base/special/floor' );
4040
*
4141
* 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 );
4342
*
44-
* var v = dnanasum( N, x, 2, 1 );
43+
* var v = dnanasum( 5, x, 2, 1 );
4544
* // returns 9.0
4645
*/
4746
function dnanasum( N, x, stride, offset ) {

0 commit comments

Comments
 (0)