Skip to content

Commit c13b428

Browse files
refactor: update blas/ext/base/sdssum to follow current project conventions
PR-URL: #2080 Closes: #1525 Ref: #1152 --------- Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent a0d8ed6 commit c13b428

File tree

16 files changed

+191
-255
lines changed

16 files changed

+191
-255
lines changed

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

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,16 @@ The function has the following parameters:
5454

5555
- **N**: number of indexed elements.
5656
- **x**: input [`Float32Array`][@stdlib/array/float32].
57-
- **stride**: index increment for `x`.
57+
- **stride**: index increment.
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 the strided array,
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, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
66-
var N = floor( x.length / 2 );
6765

68-
var v = sdssum( N, x, 2 );
66+
var v = sdssum( 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, 2.0, -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 = sdssum( N, x1, 2 );
80+
var v = sdssum( 4, x1, 2 );
8681
// returns 5.0
8782
```
8883

@@ -102,18 +97,16 @@ var v = sdssum.ndarray( N, x, 1, 0 );
10297

10398
The function has the following additional parameters:
10499

105-
- **offset**: starting index for `x`.
100+
- **offset**: starting index for the strided array.
106101

107-
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 every other value in `x` starting from the second value
102+
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 every other value in the strided array starting from the second value
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, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
114-
var N = floor( x.length / 2 );
115108

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

@@ -139,18 +132,12 @@ var v = sdssum.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' ).factory;
136+
var filledarrayBy = require( '@stdlib/array/filled-by' );
145137
var sdssum = require( '@stdlib/blas/ext/base/sdssum' );
146138

147-
var x;
148-
var i;
139+
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
149140

150-
x = new Float32Array( 10 );
151-
for ( i = 0; i < x.length; i++ ) {
152-
x[ i ] = round( randu()*100.0 );
153-
}
154141
console.log( x );
155142

156143
var v = sdssum( x.length, x, 1 );

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

Lines changed: 8 additions & 8 deletions
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' );
2524
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2625
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float32Array = require( '@stdlib/array/float32' );
26+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
27+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2828
var pkg = require( './../package.json' ).name;
2929
var sdssum = require( './../lib/sdssum.js' );
3030

3131

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

3439
/**
@@ -39,13 +44,8 @@ var sdssum = require( './../lib/sdssum.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
47+
var x = filledarrayBy( len, 'float32', rand );
4448

45-
x = new Float32Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
x[ i ] = ( randu()*10.0 ) - 20.0;
48-
}
4949
return benchmark;
5050

5151
function benchmark( b ) {

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
2625
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2726
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float32Array = require( '@stdlib/array/float32' );
2927
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
29+
var filledarrayBy = require( '@stdlib/array/filled-by' );
3030
var pkg = require( './../package.json' ).name;
3131

3232

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

4041

4142
// FUNCTIONS //
@@ -48,13 +49,8 @@ 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 );
5353

54-
x = new Float32Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
x[ i ] = ( randu()*10.0 ) - 20.0;
57-
}
5854
return benchmark;
5955

6056
function benchmark( b ) {

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,17 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
2524
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2625
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float32Array = require( '@stdlib/array/float32' );
28-
var pkg = require( './../package.json' ).name;
26+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
27+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2928
var sdssum = require( './../lib/ndarray.js' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var rand = uniform( -100.0, 100.0 );
3035

3136

3237
// FUNCTIONS //
@@ -39,13 +44,8 @@ var sdssum = require( './../lib/ndarray.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
47+
var x = filledarrayBy( len, 'float32', rand );
4448

45-
x = new Float32Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
x[ i ] = ( randu()*10.0 ) - 20.0;
48-
}
4949
return benchmark;
5050

5151
function benchmark( b ) {

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222

2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
25-
var randu = require( '@stdlib/random/base/randu' );
2625
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2726
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float32Array = require( '@stdlib/array/float32' );
2927
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
29+
var filledarrayBy = require( '@stdlib/array/filled-by' );
3030
var pkg = require( './../package.json' ).name;
3131

3232

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

4041

4142
// FUNCTIONS //
@@ -48,13 +49,8 @@ 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 );
5353

54-
x = new Float32Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
x[ i ] = ( randu()*10.0 ) - 20.0;
57-
}
5854
return benchmark;
5955

6056
function benchmark( b ) {

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

Lines changed: 8 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
using extended accumulation.
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
7+
the strided array are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use a typed
1010
array view.
@@ -34,27 +34,26 @@
3434
> {{alias}}( x.length, x, 1 )
3535
1.0
3636

37-
// Using `N` and `stride` parameters:
37+
// Using `N` and stride parameters:
3838
> x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
39-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
4039
> var stride = 2;
41-
> {{alias}}( N, x, stride )
40+
> {{alias}}( 3, x, stride )
4241
1.0
4342

4443
// Using view offsets:
4544
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
4645
> 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 );
4846
> stride = 2;
49-
> {{alias}}( N, x1, stride )
47+
> {{alias}}( 3, x1, stride )
5048
-1.0
5149

50+
5251
{{alias}}.ndarray( N, x, stride, offset )
5352
Computes the sum of single-precision floating-point strided array elements
5453
using extended accumulation and alternative indexing semantics.
5554

5655
While typed array views mandate a view offset based on the underlying
57-
buffer, the `offset` parameter supports indexing semantics based on a
56+
buffer, the offset parameter supports indexing semantics based on a
5857
starting index.
5958

6059
Parameters
@@ -85,8 +84,7 @@
8584

8685
// Using offset parameter:
8786
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
88-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
89-
> {{alias}}.ndarray( N, x, 2, 1 )
87+
> {{alias}}.ndarray( 3, x, 2, 1 )
9088
-1.0
9189

9290
See Also

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

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,12 @@
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' ).factory;
22+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2423
var sdssum = require( './../lib' );
2524

26-
var x;
27-
var i;
25+
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
2826

29-
x = new Float32Array( 10 );
30-
for ( i = 0; i < x.length; i++ ) {
31-
x[ i ] = round( randu()*100.0 );
32-
}
3327
console.log( x );
3428

3529
var v = sdssum( x.length, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/sdssum/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/sdssum/lib/ndarray.native.js

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

2627

@@ -47,10 +48,8 @@ var addon = require( './sdssum.native.js' );
4748
*/
4849
function sdssum( N, x, stride, offset ) {
4950
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
51+
offset = minViewBufferIndex( N, stride, offset );
52+
view = offsetView( x, offset );
5453
return addon( N, view, stride );
5554
}
5655

0 commit comments

Comments
 (0)