Skip to content

Commit d2ec36e

Browse files
Shubh942PranavchikuPlaneshifter
authored
refactor: update blas/ext/base/dsnansum to follow current project conventions
PR-URL: #2001 Closes: #1492 Ref: #1152 --------- Signed-off-by: Pranav Goswami <goswami.4@iitj.ac.in> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: Pranav Goswami <goswami.4@iitj.ac.in> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Pranav Goswami <goswami.4@iitj.ac.in>
1 parent 7187d1b commit d2ec36e

18 files changed

+215
-306
lines changed

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

+14-25
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,14 @@ The function has the following parameters:
5656
- **x**: input [`Float32Array`][@stdlib/array/float32].
5757
- **stride**: index increment for `x`.
5858

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

6161
```javascript
6262
var Float32Array = require( '@stdlib/array/float32' );
63-
var floor = require( '@stdlib/math/base/special/floor' );
6463

6564
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 );
6765

68-
var v = dsnansum( N, x, 2 );
66+
var v = dsnansum( 4, x, 2 );
6967
// returns 5.0
7068
```
7169

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

7674
```javascript
7775
var Float32Array = require( '@stdlib/array/float32' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7976

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

83-
var N = floor( x0.length / 2 );
84-
85-
var v = dsnansum( N, x1, 2 );
80+
var v = dsnansum( 4, x1, 2 );
8681
// returns 5.0
8782
```
8883

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

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

99-
var v = dsnansum.ndarray( N, x, 1, 0 );
93+
var v = dsnansum.ndarray( 4, x, 1, 0 );
10094
// returns 1.0
10195
```
10296

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

109103
```javascript
110104
var Float32Array = require( '@stdlib/array/float32' );
111-
var floor = require( '@stdlib/math/base/special/floor' );
112105

113106
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 );
115107

116-
var v = dsnansum.ndarray( N, x, 2, 1 );
108+
var v = dsnansum.ndarray( 4, x, 2, 1 );
117109
// returns 5.0
118110
```
119111

@@ -139,22 +131,19 @@ var v = dsnansum.ndarray( N, x, 2, 1 );
139131
<!-- eslint no-undef: "error" -->
140132

141133
```javascript
142-
var randu = require( '@stdlib/random/base/randu' );
143-
var round = require( '@stdlib/math/base/special/round' );
144-
var Float32Array = require( '@stdlib/array/float32' );
134+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
135+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
136+
var filledarrayBy = require( '@stdlib/array/filled-by' );
145137
var dsnansum = require( '@stdlib/blas/ext/base/dsnansum' );
146138

147-
var x;
148-
var i;
149-
150-
x = new Float32Array( 10 );
151-
for ( i = 0; i < x.length; i++ ) {
152-
if ( randu() < 0.2 ) {
153-
x[ i ] = NaN;
154-
} else {
155-
x[ i ] = round( randu()*100.0 );
139+
function clbk() {
140+
if ( bernoulli( 0.7 ) > 0 ) {
141+
return discreteUniform( -10, 10 );
156142
}
143+
return NaN;
157144
}
145+
146+
var x = filledarrayBy( 10, 'float64', clbk );
158147
console.log( x );
159148

160149
var v = dsnansum( x.length, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/dsnansum/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 discreteUniform = require( '@stdlib/random/base/discrete-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 Float32Array = require( '@stdlib/array/float32' );
2829
var pkg = require( './../package.json' ).name;
2930
var dsnansum = require( './../lib/dsnansum.js' );
3031

@@ -39,18 +40,15 @@ var dsnansum = require( './../lib/dsnansum.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.7 ) > 0 ) {
48+
return discreteUniform( -10, 10 );
5149
}
50+
return NaN;
5251
}
53-
return benchmark;
5452

5553
function benchmark( b ) {
5654
var v;

lib/node_modules/@stdlib/blas/ext/base/dsnansum/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 discreteUniform = require( '@stdlib/random/base/discrete-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 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.7 ) > 0 ) {
57+
return discreteUniform( -10, 10 );
6058
}
59+
return NaN;
6160
}
62-
return benchmark;
6361

6462
function benchmark( b ) {
6563
var v;

lib/node_modules/@stdlib/blas/ext/base/dsnansum/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 discreteUniform = require( '@stdlib/random/base/discrete-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 Float32Array = require( '@stdlib/array/float32' );
2829
var pkg = require( './../package.json' ).name;
2930
var dsnansum = require( './../lib/ndarray.js' );
3031

@@ -39,18 +40,15 @@ var dsnansum = 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.7 ) > 0 ) {
48+
return discreteUniform( -10, 10 );
5149
}
50+
return NaN;
5251
}
53-
return benchmark;
5452

5553
function benchmark( b ) {
5654
var v;

lib/node_modules/@stdlib/blas/ext/base/dsnansum/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 discreteUniform = require( '@stdlib/random/base/discrete-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 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.7 ) > 0 ) {
57+
return discreteUniform( -10, 10 );
6058
}
59+
return NaN;
6160
}
62-
return benchmark;
6361

6462
function benchmark( b ) {
6563
var v;

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

+7-11
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
ignoring `NaN` values, using extended accumulation, and returning an
55
extended precision result.
66

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

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

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

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

49+
5350
{{alias}}.ndarray( N, x, stride, offset )
5451
Computes the sum of single-precision floating-point strided array elements,
5552
ignoring `NaN` values and using extended accumulation and alternative
@@ -86,9 +83,8 @@
8683
1.0
8784

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

9490
See Also

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

+9-10
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,21 @@
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 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 dsnansum = require( './../lib' );
2525

2626
var x;
27-
var i;
2827

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 );
28+
function rand() {
29+
if ( bernoulli( 0.7 ) > 0 ) {
30+
return discreteUniform( -100, 100 );
3531
}
32+
return NaN;
3633
}
34+
35+
x = filledarrayBy( 10, 'float64', rand );
3736
console.log( x );
3837

3938
var v = dsnansum( x.length, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/dsnansum/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

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,11 @@
3535
*
3636
* @example
3737
* var Float32Array = require( '@stdlib/array/float32' );
38-
* var floor = require( '@stdlib/math/base/special/floor' );
3938
* var dsnansum = require( '@stdlib/blas/ext/base/dsnansum' );
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 = dsnansum.ndarray( N, x, 2, 1 );
42+
* var v = dsnansum.ndarray( 5, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,10 @@ var dsnansumpw = require( '@stdlib/blas/ext/base/dsnansumpw' ).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 = dsnansum( N, x, 2, 1 );
42+
* var v = dsnansum( 5, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745
function dsnansum( N, x, stride, offset ) {

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

+5-8
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020

2121
// MODULES //
2222

23-
var Float32Array = require( '@stdlib/array/float32' );
23+
var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
24+
var offsetView = require( '@stdlib/strided/base/offset-view' );
2425
var addon = require( './dsnansum.native.js' );
2526

2627

@@ -37,20 +38,16 @@ var addon = require( './dsnansum.native.js' );
3738
*
3839
* @example
3940
* var Float32Array = require( '@stdlib/array/float32' );
40-
* var floor = require( '@stdlib/math/base/special/floor' );
4141
*
4242
* 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 );
4443
*
45-
* var v = dsnansum( N, x, 2, 1 );
44+
* var v = dsnansum( 5, x, 2, 1 );
4645
* // returns 5.0
4746
*/
4847
function dsnansum( N, x, stride, offset ) {
4948
var view;
50-
if ( stride < 0 ) {
51-
offset += (N-1) * stride;
52-
}
53-
view = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len
49+
offset = minViewBufferIndex( N, stride, offset );
50+
view = offsetView( x, offset );
5451
return addon( N, view, stride );
5552
}
5653

0 commit comments

Comments
 (0)