Skip to content

Commit e4f0dcd

Browse files
rxbryankgryte
andauthored
refactor: update blas/ext/base/sapx to follow current project conventions
PR-URL: #1824 Closes: #1509 Ref: #1152 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Athan Reines <[email protected]>
1 parent f25615d commit e4f0dcd

17 files changed

+185
-287
lines changed

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

+8-28
Original file line numberDiff line numberDiff line change
@@ -50,34 +50,30 @@ The function has the following parameters:
5050
- **x**: input [`Float32Array`][@stdlib/array/float32].
5151
- **stride**: index increment.
5252

53-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to add a constant to every other element
53+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element
5454

5555
```javascript
5656
var Float32Array = require( '@stdlib/array/float32' );
57-
var floor = require( '@stdlib/math/base/special/floor' );
5857

5958
var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
60-
var N = floor( x.length / 2 );
6159

62-
sapx( N, 5.0, x, 2 );
60+
sapx( 4, 5.0, x, 2 );
6361
// x => <Float32Array>[ 3.0, 1.0, 8.0, -5.0, 9.0, 0.0, 4.0, -3.0 ]
6462
```
6563

6664
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
6765

6866
```javascript
6967
var Float32Array = require( '@stdlib/array/float32' );
70-
var floor = require( '@stdlib/math/base/special/floor' );
7168

7269
// Initial array...
7370
var x0 = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
7471

7572
// Create an offset view...
7673
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
77-
var N = floor( x0.length/2 );
7874

7975
// Add a constant to every other element...
80-
sapx( N, 5.0, x1, 2 );
76+
sapx( 3, 5.0, x1, 2 );
8177
// x0 => <Float32Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
8278
```
8379

@@ -98,7 +94,7 @@ The function has the following additional parameters:
9894

9995
- **offset**: starting index.
10096

101-
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 only the last three elements of `x`
97+
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 only the last three elements of the strided array
10298

10399
```javascript
104100
var Float32Array = require( '@stdlib/array/float32' );
@@ -117,7 +113,7 @@ sapx.ndarray( 3, 5.0, x, 1, x.length-3 );
117113

118114
## Notes
119115

120-
- If `N <= 0`, both functions return `x` unchanged.
116+
- If `N <= 0`, both functions return the input array unchanged.
121117

122118
</section>
123119

@@ -130,27 +126,11 @@ sapx.ndarray( 3, 5.0, x, 1, x.length-3 );
130126
<!-- eslint no-undef: "error" -->
131127

132128
```javascript
133-
var round = require( '@stdlib/math/base/special/round' );
134-
var randu = require( '@stdlib/random/base/randu' );
135-
var Float32Array = require( '@stdlib/array/float32' );
129+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
130+
var filledarrayBy = require( '@stdlib/array/filled-by' );
136131
var sapx = require( '@stdlib/blas/ext/base/sapx' );
137132

138-
var rand;
139-
var sign;
140-
var x;
141-
var i;
142-
143-
x = new Float32Array( 10 );
144-
for ( i = 0; i < x.length; i++ ) {
145-
rand = round( randu()*100.0 );
146-
sign = randu();
147-
if ( sign < 0.5 ) {
148-
sign = -1.0;
149-
} else {
150-
sign = 1.0;
151-
}
152-
x[ i ] = sign * rand;
153-
}
133+
var x = filledarrayBy( 10, 'float32', uniform( -100.0, 100.0 ) );
154134
console.log( x );
155135

156136
sapx( x.length, 5.0, x, 1 );

Diff for: lib/node_modules/@stdlib/blas/ext/base/sapx/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' );
24+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float32Array = require( '@stdlib/array/float32' );
2828
var pkg = require( './../package.json' ).name;
2929
var sapx = require( './../lib/sapx.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 sapx = require( './../lib/sapx.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 < len; 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/sapx/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' );
25+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2627
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float32Array = require( '@stdlib/array/float32' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

@@ -36,6 +36,7 @@ var sapx = tryRequire( resolve( __dirname, './../lib/sapx.native.js' ) );
3636
var opts = {
3737
'skip': ( sapx 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 < len; 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/sapx/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' );
24+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
25+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float32Array = require( '@stdlib/array/float32' );
2828
var pkg = require( './../package.json' ).name;
2929
var sapx = 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 sapx = 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 < len; 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/sapx/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' );
25+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
26+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2627
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2728
var pow = require( '@stdlib/math/base/special/pow' );
28-
var Float32Array = require( '@stdlib/array/float32' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

@@ -36,6 +36,7 @@ var sapx = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
3636
var opts = {
3737
'skip': ( sapx 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 < len; 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/sapx/docs/repl.txt

+14-24
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
Adds a constant to each element in a single-precision floating-point strided
44
array.
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 typed
1010
array views.
1111

12-
If `N <= 0`, the function returns `x` unchanged.
12+
If `N <= 0`, the function returns the strided array unchanged.
1313

1414
Parameters
1515
----------
@@ -23,40 +23,34 @@
2323
Input array.
2424

2525
stride: integer
26-
Index increment for `x`.
26+
Index increment.
2727

2828
Returns
2929
-------
3030
x: Float32Array
31-
Input array `x`.
31+
Input array.
3232

3333
Examples
3434
--------
3535
// Standard Usage:
3636
> var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
37-
> var alpha = 5.0;
38-
> {{alias}}( x.length, alpha, x, 1 )
37+
> {{alias}}( x.length, 5.0, x, 1 )
3938
<Float32Array>[ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ]
4039

4140
// Using `N` and `stride` parameters:
4241
> x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
43-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
44-
> alpha = 5.0;
45-
> var stride = 2;
46-
> {{alias}}( N, alpha, x, stride )
42+
> {{alias}}( 3, 5.0, x, 2 )
4743
<Float32Array>[ 3.0, 1.0, 8.0, -5.0, 9.0, -1.0, -3.0 ]
4844

4945
// Using view offsets:
5046
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
5147
> var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
52-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
53-
> alpha = 5.0;
54-
> stride = 2;
55-
> {{alias}}( N, alpha, x1, stride )
48+
> {{alias}}( 3, 5.0, x1, 2 )
5649
<Float32Array>[ 3.0, 3.0, 1.0, 5.0, -1.0 ]
5750
> x0
5851
<Float32Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
5952

53+
6054
{{alias}}.ndarray( N, alpha, x, stride, offset )
6155
Adds a constant to each element in a single-precision floating-point strided
6256
array using alternative indexing semantics.
@@ -77,30 +71,26 @@
7771
Input array.
7872

7973
stride: integer
80-
Index increment for `x`.
74+
Index increment.
8175

8276
offset: integer
83-
Starting index of `x`.
77+
Starting index.
8478

8579
Returns
8680
-------
8781
x: Float32Array
88-
Input array `x`.
82+
Input array.
8983

9084
Examples
9185
--------
9286
// Standard Usage:
9387
> var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
94-
> var alpha = 5.0;
95-
> {{alias}}.ndarray( x.length, alpha, x, 1, 0 )
88+
> {{alias}}.ndarray( x.length, 5.0, x, 1, 0 )
9689
<Float32Array>[ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ]
9790

9891
// Using an index offset:
9992
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
100-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
101-
> alpha = 5.0;
102-
> var stride = 2;
103-
> {{alias}}.ndarray( N, alpha, x, stride, 1 )
93+
> {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
10494
<Float32Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
10595

10696
See Also

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

+3-18
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,12 @@
1818

1919
'use strict';
2020

21-
var round = require( '@stdlib/math/base/special/round' );
22-
var randu = require( '@stdlib/random/base/randu' );
23-
var Float32Array = require( '@stdlib/array/float32' );
21+
var uniform = require( '@stdlib/random/base/uniform' ).factory;
22+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2423
var sapx = require( './../lib' );
2524

26-
var rand;
27-
var sign;
28-
var x;
29-
var i;
25+
var x = filledarrayBy( 10, 'float32', uniform( -100.0, 100.0 ) );
3026

31-
x = new Float32Array( 10 );
32-
for ( i = 0; i < x.length; i++ ) {
33-
rand = round( randu()*100.0 );
34-
sign = randu();
35-
if ( sign < 0.5 ) {
36-
sign = -1.0;
37-
} else {
38-
sign = 1.0;
39-
}
40-
x[ i ] = sign * rand;
41-
}
4227
console.log( x );
4328

4429
sapx( x.length, 5.0, x, 1 );

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

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

2627

@@ -47,10 +48,8 @@ var addon = require( './sapx.native.js' );
4748
*/
4849
function sapx( N, alpha, 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
addon( N, alpha, view, stride );
5554
return x;
5655
}

0 commit comments

Comments
 (0)