Skip to content

Commit e5a3c8e

Browse files
committed
refactor: update blas/ext/base/sapxsum to follow current project conventions
1 parent 58e8c9a commit e5a3c8e

17 files changed

+113
-242
lines changed

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

+8-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 access 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 access 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, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
66-
var N = floor( x.length / 2 );
6765

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

@@ -104,16 +99,14 @@ The function has the following additional parameters:
10499

105100
- **offset**: starting index for `x`.
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 access 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 access every other value in `x` 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 = sapxsum.ndarray( N, 5.0, x, 2, 1 );
109+
var v = sapxsum.ndarray( 4, 5.0, x, 2, 1 );
117110
// returns 25.0
118111
```
119112

@@ -138,22 +131,12 @@ var v = sapxsum.ndarray( N, 5.0, x, 2, 1 );
138131
<!-- eslint no-undef: "error" -->
139132

140133
```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' );
134+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
135+
var filledarrayBy = require( '@stdlib/array/filled-by' );
144136
var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' );
145137

146-
var x;
147-
var i;
148-
149-
x = new Float32Array( 10 );
150-
for ( i = 0; i < x.length; i++ ) {
151-
x[ i ] = round( randu()*100.0 );
152-
}
138+
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
153139
console.log( x );
154-
155-
var v = sapxsum( x.length, 5.0, x, 1 );
156-
console.log( v );
157140
```
158141

159142
</section>

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

+8-9
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 sapxsum = require( './../lib/sapxsum.js' );
3030

3131

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

3439
/**
@@ -39,13 +44,7 @@ var sapxsum = require( './../lib/sapxsum.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float32Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
x[ i ] = ( randu()*20.0 ) - 10.0;
48-
}
47+
var x = filledarrayBy( len, 'float32', rand );
4948
return benchmark;
5049

5150
function benchmark( b ) {

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

+4-9
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
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' );
27+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
28+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

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

4041

4142
// FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float32Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
x[ i ] = ( randu()*20.0 ) - 10.0;
57-
}
52+
var x = filledarrayBy( len, 'float32', rand );
5853
return benchmark;
5954

6055
function benchmark( b ) {

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

+8-9
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 sapxsum = require( './../lib/ndarray.js' );
3030

3131

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

3439
/**
@@ -39,13 +44,7 @@ var sapxsum = require( './../lib/ndarray.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var i;
44-
45-
x = new Float32Array( len );
46-
for ( i = 0; i < x.length; i++ ) {
47-
x[ i ] = ( randu()*20.0 ) - 10.0;
48-
}
47+
var x = filledarrayBy( len, 'float32', rand );
4948
return benchmark;
5049

5150
function benchmark( b ) {

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

+4-9
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
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' );
27+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
28+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

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

4041

4142
// FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var i;
53-
54-
x = new Float32Array( len );
55-
for ( i = 0; i < x.length; i++ ) {
56-
x[ i ] = ( randu()*20.0 ) - 10.0;
57-
}
52+
var x = filledarrayBy( len, 'float32', rand );
5853
return benchmark;
5954

6055
function benchmark( b ) {

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

+8-10
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Adds a constant to each single-precision floating-point strided array
44
element and computes the sum.
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.
@@ -37,27 +37,26 @@
3737
> {{alias}}( x.length, 5.0, x, 1 )
3838
16.0
3939

40-
// Using `N` and `stride` parameters:
40+
// Using `N` and stride parameters:
4141
> x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
42-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
4342
> var stride = 2;
44-
> {{alias}}( N, 5.0, x, stride )
43+
> {{alias}}( 3, 5.0, x, stride )
4544
16.0
4645

4746
// Using view offsets:
4847
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
4948
> var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
50-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
5149
> stride = 2;
52-
> {{alias}}( N, 5.0, x1, stride )
50+
> {{alias}}( 3, 5.0, x1, stride )
5351
14.0
5452

53+
5554
{{alias}}.ndarray( N, alpha, x, stride, offset )
5655
Adds a constant to each single-precision floating-point strided array
5756
element and computes the sum using alternative indexing semantics.
5857

5958
While typed array views mandate a view offset based on the underlying
60-
buffer, the `offset` parameter supports indexing semantics based on a
59+
buffer, the offset parameter supports indexing semantics based on a
6160
starting index.
6261

6362
Parameters
@@ -91,8 +90,7 @@
9190

9291
// Using offset parameter:
9392
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
94-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
95-
> {{alias}}.ndarray( N, 5.0, x, 2, 1 )
93+
> {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
9694
14.0
9795

9896
See Also

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

+3-10
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,11 @@
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 sapxsum = require( './../lib' );
2524

26-
var x;
27-
var i;
28-
29-
x = new Float32Array( 10 );
30-
for ( i = 0; i < x.length; i++ ) {
31-
x[ i ] = round( randu()*100.0 );
32-
}
25+
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ));
3326
console.log( x );
3427

3528
var v = sapxsum( x.length, 5.0, x, 1 );

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@
3535
*
3636
* @example
3737
* var Float32Array = require( '@stdlib/array/float32' );
38-
* var floor = require( '@stdlib/math/base/special/floor' );
3938
* var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' );
4039
*
4140
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
42-
* var N = floor( x.length / 2 );
41+
* var N = 4;
4342
*
4443
* var v = sapxsum.ndarray( N, 5.0, x, 2, 1 );
4544
* // returns 25.0

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,9 @@ var sapxsumkbn = require( '@stdlib/blas/ext/base/sapxsumkbn' ).ndarray;
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 ] );
43-
* var N = floor( x.length / 2 );
42+
* var N = 4;
4443
*
4544
* var v = sapxsum( N, 5.0, x, 2, 1 );
4645
* // returns 25.0

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

+5-7
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( './sapxsum.native.js' );
2526

2627

@@ -38,20 +39,17 @@ var addon = require( './sapxsum.native.js' );
3839
*
3940
* @example
4041
* var Float32Array = require( '@stdlib/array/float32' );
41-
* var floor = require( '@stdlib/math/base/special/floor' );
4242
*
4343
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
44-
* var N = floor( x.length / 2 );
44+
* var N = 3;
4545
*
4646
* var v = sapxsum( N, 5.0, x, 2, 1 );
4747
* // returns 25.0
4848
*/
4949
function sapxsum( N, alpha, x, stride, offset ) {
5050
var view;
51-
if ( stride < 0 ) {
52-
offset += (N-1) * stride;
53-
}
54-
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 );
5553
return addon( N, alpha, view, stride );
5654
}
5755

0 commit comments

Comments
 (0)