Skip to content

Commit 919f75a

Browse files
refactor: update blas/ext/base/snansum to follow current project convention
PR-URL: #2227 Closes: #1528 Ref: #1152 --------- Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent e92cdd8 commit 919f75a

20 files changed

+206
-306
lines changed

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

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ Computes the sum of single-precision floating-point strided array elements, igno
4444
var Float32Array = require( '@stdlib/array/float32' );
4545

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

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

@@ -56,16 +55,14 @@ The function has the following parameters:
5655
- **x**: input [`Float32Array`][@stdlib/array/float32].
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 array are accessed at runtime. For example, to compute the sum of every other element in `x`,
6059

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

6563
var x = new Float32Array( [ 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 = snansum( N, x, 2 );
65+
var v = snansum( 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 Float32Array = require( '@stdlib/array/float32' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7975

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

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

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

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

99-
var v = snansum.ndarray( N, x, 1, 0 );
92+
var v = snansum.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 Float32Array = require( '@stdlib/array/float32' );
111-
var floor = require( '@stdlib/math/base/special/floor' );
112104

113105
var x = new Float32Array( [ 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 = snansum.ndarray( N, x, 2, 1 );
107+
var v = snansum.ndarray( 4, x, 2, 1 );
117108
// returns 5.0
118109
```
119110

@@ -138,22 +129,19 @@ var v = snansum.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 Float32Array = require( '@stdlib/array/float32' );
132+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
133+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
134+
var filledarrayBy = require( '@stdlib/array/filled-by' );
144135
var snansum = require( '@stdlib/blas/ext/base/snansum' );
145136

146-
var x;
147-
var i;
148-
149-
x = new Float32Array( 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 );
137+
function rand() {
138+
if ( bernoulli( 0.8 ) > 0 ) {
139+
return discreteUniform( 0, 100 );
155140
}
141+
return NaN;
156142
}
143+
144+
var x = filledarrayBy( 10, 'float32', rand );
157145
console.log( x );
158146

159147
var v = snansum( x.length, x, 1 );

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

Lines changed: 9 additions & 11 deletions
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 uniform = require( '@stdlib/random/base/uniform' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
2829
var pkg = require( './../package.json' ).name;
2930
var snansum = require( './../lib/snansum.js' );
3031

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

45-
x = new Float32Array( 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;
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;

lib/node_modules/@stdlib/blas/ext/base/snansum/benchmark/benchmark.native.js

Lines changed: 9 additions & 11 deletions
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 uniform = require( '@stdlib/random/base/uniform' );
26+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
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, 'float32', rand );
53+
return benchmark;
5354

54-
x = new Float32Array( 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;
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;

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

Lines changed: 9 additions & 11 deletions
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 uniform = require( '@stdlib/random/base/uniform' );
25+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
2829
var pkg = require( './../package.json' ).name;
2930
var snansum = require( './../lib/ndarray.js' );
3031

@@ -39,18 +40,15 @@ var snansum = 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, 'float32', rand );
44+
return benchmark;
4445

45-
x = new Float32Array( 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;
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;

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

Lines changed: 9 additions & 11 deletions
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 uniform = require( '@stdlib/random/base/uniform' );
26+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
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, 'float32', rand );
53+
return benchmark;
5354

54-
x = new Float32Array( 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;
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;

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

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Computes the sum of single-precision floating-point strided array elements,
44
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 array
7+
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/float32}}( [ -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/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
4644
> var x1 = new {{alias:@stdlib/array/float32}}( 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 single-precision floating-point strided array elements,
5451
ignoring `NaN` values and using alternative indexing semantics.
@@ -85,8 +82,7 @@
8582

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

9288
See Also

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

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +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 Float32Array = require( '@stdlib/array/float32' );
21+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
22+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
23+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2424
var snansum = require( './../lib' );
2525

26-
var x;
27-
var i;
28-
29-
x = new Float32Array( 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
}
37-
console.log( x );
32+
33+
var x = filledarrayBy( 10, 'float32', rand );
3834

3935
var v = snansum( x.length, x, 1 );
4036
console.log( v );

lib/node_modules/@stdlib/blas/ext/base/snansum/include.gypi

Lines changed: 1 addition & 1 deletion
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

lib/node_modules/@stdlib/blas/ext/base/snansum/lib/index.js

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@
2828
* var snansum = require( '@stdlib/blas/ext/base/snansum' );
2929
*
3030
* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
31-
* var N = x.length;
3231
*
33-
* var v = snansum( N, x, 1 );
32+
* var v = snansum( 4, x, 1 );
3433
* // returns 1.0
3534
*
3635
* @example
@@ -39,9 +38,8 @@
3938
* var snansum = require( '@stdlib/blas/ext/base/snansum' );
4039
*
4140
* var x = new Float32Array( [ 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 );
4341
*
44-
* var v = snansum.ndarray( N, x, 2, 1 );
42+
* var v = snansum.ndarray( 5, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745

lib/node_modules/@stdlib/blas/ext/base/snansum/lib/ndarray.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,10 @@ var snansumkbn = require( '@stdlib/blas/ext/base/snansumkbn' ).ndarray;
3636
*
3737
* @example
3838
* var Float32Array = require( '@stdlib/array/float32' );
39-
* var floor = require( '@stdlib/math/base/special/floor' );
4039
*
4140
* var x = new Float32Array( [ 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 );
4341
*
44-
* var v = snansum( N, x, 2, 1 );
42+
* var v = snansum( 5, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745
function snansum( N, x, stride, offset ) {

lib/node_modules/@stdlib/blas/ext/base/snansum/lib/ndarray.native.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,10 @@ var addon = require( './snansum.native.js' );
3737
*
3838
* @example
3939
* var Float32Array = require( '@stdlib/array/float32' );
40-
* var floor = require( '@stdlib/math/base/special/floor' );
4140
*
4241
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
43-
* var N = floor( x.length / 2 );
4442
*
45-
* var v = snansum( N, x, 2, 1 );
43+
* var v = snansum( 5, x, 2, 1 );
4644
* // returns 5.0
4745
*/
4846
function snansum( N, x, stride, offset ) {

0 commit comments

Comments
 (0)