Skip to content

Commit a0d8ed6

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

20 files changed

+193
-300
lines changed

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

+9-24
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ Computes the sum of single-precision floating-point strided array elements using
4444
var Float32Array = require( '@stdlib/array/float32' );
4545

4646
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
47-
var N = x.length;
4847

49-
var v = dssumors( N, x, 1 );
48+
var v = dssumors( 3, x, 1 );
5049
// returns 1.0
5150
```
5251

@@ -56,16 +55,14 @@ The function has the following parameters:
5655
- **x**: input [`Float32Array`][@stdlib/array/float32].
5756
- **stride**: index increment for `x`.
5857

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`,
58+
The `N` and `stride` parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the sum of every other element in `x`,
6059

6160
```javascript
6261
var Float32Array = require( '@stdlib/array/float32' );
63-
var floor = require( '@stdlib/math/base/special/floor' );
6462

6563
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 );
6764

68-
var v = dssumors( N, x, 2 );
65+
var v = dssumors( 4, x, 2 );
6966
// returns 5.0
7067
```
7168

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

7673
```javascript
7774
var Float32Array = require( '@stdlib/array/float32' );
78-
var floor = require( '@stdlib/math/base/special/floor' );
7975

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

83-
var N = floor( x0.length / 2 );
84-
85-
var v = dssumors( N, x1, 2 );
79+
var v = dssumors( 4, x1, 2 );
8680
// returns 5.0
8781
```
8882

@@ -94,9 +88,8 @@ Computes the sum of single-precision floating-point strided array elements using
9488
var Float32Array = require( '@stdlib/array/float32' );
9589

9690
var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
97-
var N = x.length;
9891

99-
var v = dssumors.ndarray( N, x, 1, 0 );
92+
var v = dssumors.ndarray( 3, x, 1, 0 );
10093
// returns 1.0
10194
```
10295

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

109102
```javascript
110103
var Float32Array = require( '@stdlib/array/float32' );
111-
var floor = require( '@stdlib/math/base/special/floor' );
112104

113105
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 );
115106

116-
var v = dssumors.ndarray( N, x, 2, 1 );
107+
var v = dssumors.ndarray( 4, x, 2, 1 );
117108
// returns 5.0
118109
```
119110

@@ -139,18 +130,12 @@ var v = dssumors.ndarray( N, x, 2, 1 );
139130
<!-- eslint no-undef: "error" -->
140131

141132
```javascript
142-
var randu = require( '@stdlib/random/base/randu' );
143-
var round = require( '@stdlib/math/base/special/round' );
133+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
134+
var filledarrayBy = require( '@stdlib/array/filled-by' );
144135
var Float32Array = require( '@stdlib/array/float32' );
145136
var dssumors = require( '@stdlib/blas/ext/base/dssumors' );
146137

147-
var x;
148-
var i;
149-
150-
x = new Float32Array( 10 );
151-
for ( i = 0; i < x.length; i++ ) {
152-
x[ i ] = round( randu()*100.0 );
153-
}
138+
var x = filledarrayBy( 10, 'float64', discreteUniform( 0, 100 ) );
154139
console.log( x );
155140

156141
var v = dssumors( x.length, x, 1 );

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

3131

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

3439
/**
@@ -39,13 +44,7 @@ var dssumors = require( './../lib/dssumors.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()*10.0 ) - 20.0;
48-
}
47+
var x = filledarrayBy( len, 'float32', rand );
4948
return benchmark;
5049

5150
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/dssumors/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 dssumors = tryRequire( resolve( __dirname, './../lib/dssumors.native.js' ) )
3636
var opts = {
3737
'skip': ( dssumors instanceof Error )
3838
};
39+
var rand = uniform( -10.0, 10.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()*10.0 ) - 20.0;
57-
}
52+
var x = filledarrayBy( len, 'float32', rand );
5853
return benchmark;
5954

6055
function benchmark( b ) {

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

3131

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

3439
/**
@@ -39,13 +44,7 @@ var dssumors = 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()*10.0 ) - 20.0;
48-
}
47+
var x = filledarrayBy( len, 'float32', rand );
4948
return benchmark;
5049

5150
function benchmark( b ) {

lib/node_modules/@stdlib/blas/ext/base/dssumors/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 dssumors = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
3636
var opts = {
3737
'skip': ( dssumors instanceof Error )
3838
};
39+
var rand = uniform( -10.0, 10.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()*10.0 ) - 20.0;
57-
}
52+
var x = filledarrayBy( len, 'float32', rand );
5853
return benchmark;
5954

6055
function benchmark( b ) {

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

+6-10
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
using ordinary recursive summation with extended accumulation and returning
55
an 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 ] );
40-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
41-
> var stride = 2;
42-
> {{alias}}( N, x, stride )
40+
> {{alias}}( 3, 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 ] );
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}}( 3, 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
using ordinary recursive summation with extended accumulation and
@@ -87,8 +84,7 @@
8784

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

9490
See Also

lib/node_modules/@stdlib/blas/ext/base/dssumors/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 dssumors = 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 = dssumors( x.length, x, 1 );

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ var M = 6;
3737
* var Float32Array = require( '@stdlib/array/float32' );
3838
*
3939
* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
40-
* var N = x.length;
4140
*
42-
* var v = dssumors( N, x, 1 );
41+
* var v = dssumors( 3, x, 1 );
4342
* // returns 1.0
4443
*/
4544
function dssumors( N, x, stride ) {

lib/node_modules/@stdlib/blas/ext/base/dssumors/lib/dssumors.native.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ var addon = require( './../src/addon.node' );
3737
* var Float32Array = require( '@stdlib/array/float32' );
3838
*
3939
* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
40-
* var N = x.length;
4140
*
42-
* var v = dssumors( N, x, 1 );
41+
* var v = dssumors( 3, x, 1 );
4342
* // returns 1.0
4443
*/
4544
function dssumors( N, x, stride ) {

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

+2-5
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,17 @@
2828
* var dssumors = require( '@stdlib/blas/ext/base/dssumors' );
2929
*
3030
* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
31-
* var N = x.length;
3231
*
33-
* var v = dssumors( N, x, 1 );
32+
* var v = dssumors( 3, x, 1 );
3433
* // returns 1.0
3534
*
3635
* @example
3736
* var Float32Array = require( '@stdlib/array/float32' );
38-
* var floor = require( '@stdlib/math/base/special/floor' );
3937
* var dssumors = require( '@stdlib/blas/ext/base/dssumors' );
4038
*
4139
* 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 );
4340
*
44-
* var v = dssumors.ndarray( N, x, 2, 1 );
41+
* var v = dssumors.ndarray( 4, x, 2, 1 );
4542
* // returns 5.0
4643
*/
4744

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,10 @@ var M = 6;
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 ] );
42-
* var N = floor( x.length / 2 );
4341
*
44-
* var v = dssumors( N, x, 2, 1 );
42+
* var v = dssumors( 4, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745
function dssumors( N, x, stride, offset ) {

0 commit comments

Comments
 (0)