Skip to content

Commit f478364

Browse files
AgPriyanshu18Planeshifter
AgPriyanshu18
and
Planeshifter
authored
refactor: update blas/ext/base/snansumpw to follow current projects conventions
PR-URL: #1711 Closes: #1532 Ref: #1152 --------- Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 8f355fa commit f478364

File tree

18 files changed

+218
-305
lines changed

18 files changed

+218
-305
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/README.md

Lines changed: 13 additions & 23 deletions
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 = snansumpw( N, x, 2 );
66+
var v = snansumpw( 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 = snansumpw( N, x1, 2 );
80+
var v = snansumpw( 4, x1, 2 );
8681
// returns 5.0
8782
```
8883

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

109104
```javascript
110105
var Float32Array = require( '@stdlib/array/float32' );
111-
var floor = require( '@stdlib/math/base/special/floor' );
112106

113107
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 );
115108

116-
var v = snansumpw.ndarray( N, x, 2, 1 );
109+
var v = snansumpw.ndarray( 4, x, 2, 1 );
117110
// returns 5.0
118111
```
119112

@@ -139,22 +132,19 @@ var v = snansumpw.ndarray( N, x, 2, 1 );
139132
<!-- eslint no-undef: "error" -->
140133

141134
```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' );
135+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
136+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
137+
var filledarrayBy = require( '@stdlib/array/filled-by' );
145138
var snansumpw = require( '@stdlib/blas/ext/base/snansumpw' );
146139

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 );
140+
function rand() {
141+
if ( bernoulli( 0.2 ) > 0 ) {
142+
return NaN;
156143
}
144+
return discreteUniform( 0, 100 );
157145
}
146+
147+
var x = filledarrayBy( 10, 'float32', rand );
158148
console.log( x );
159149

160150
var v = snansumpw( x.length, x, 1 );

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/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 snansumpw = require( './../lib/snansumpw.js' );
3031

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

5553
function benchmark( b ) {
5654
var v;

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/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, 10 );
6058
}
59+
return NaN;
6160
}
62-
return benchmark;
6361

6462
function benchmark( b ) {
6563
var v;

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/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 snansumpw = require( './../lib/ndarray.js' );
3031

@@ -39,18 +40,15 @@ var snansumpw = 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, 10 );
5149
}
50+
return NaN;
5251
}
53-
return benchmark;
5452

5553
function benchmark( b ) {
5654
var v;

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

Lines changed: 10 additions & 10 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

@@ -49,17 +50,16 @@ var opts = {
4950
*/
5051
function createBenchmark( len ) {
5152
var x;
52-
var i;
5353

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;
54+
x = filledarrayBy( len, 'float32', rand );
55+
return benchmark;
56+
57+
function rand() {
58+
if ( bernoulli( 0.8 ) > 0 ) {
59+
return uniform( -10, 10 );
6060
}
61+
return NaN;
6162
}
62-
return benchmark;
6363

6464
function benchmark( b ) {
6565
var v;

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/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 and using pairwise summation.
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/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 pairwise summation and alternative indexing
@@ -86,8 +83,7 @@
8683

8784
// Using offset parameter:
8885
> var x = new {{alias:@stdlib/array/float32}}( [ 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

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

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -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 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 snansumpw = 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.2 ) > 0 ) {
28+
return NaN;
3529
}
30+
return discreteUniform( 0, 100 );
3631
}
32+
33+
var x = filledarrayBy( 10, 'float32', rand );
3734
console.log( x );
3835

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

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/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/snansumpw/lib/index.js

Lines changed: 1 addition & 3 deletions
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 snansumpw = require( '@stdlib/blas/ext/base/snansumpw' );
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 = snansumpw.ndarray( N, x, 2, 1 );
42+
* var v = snansumpw.ndarray( 5, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745

‎lib/node_modules/@stdlib/blas/ext/base/snansumpw/lib/ndarray.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,10 @@ var BLOCKSIZE = 128;
5252
*
5353
* @example
5454
* var Float32Array = require( '@stdlib/array/float32' );
55-
* var floor = require( '@stdlib/math/base/special/floor' );
5655
*
5756
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
58-
* var N = floor( x.length / 2 );
5957
*
60-
* var v = snansumpw( N, x, 2, 1 );
58+
* var v = snansumpw( 5, x, 2, 1 );
6159
* // returns 5.0
6260
*/
6361
function snansumpw( N, x, stride, offset ) {

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

Lines changed: 5 additions & 8 deletions
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( './snansumpw.native.js' );
2526

2627

@@ -37,20 +38,16 @@ var addon = require( './snansumpw.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 = snansumpw( N, x, 2, 1 );
44+
* var v = snansumpw( 5, x, 2, 1 );
4645
* // returns 5.0
4746
*/
4847
function snansumpw( 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)