Skip to content

Commit 2fafc74

Browse files
vr-varadkgryte
andauthored
refactor: update blas/ext/base/ssumkbn2 to follow current project conventions
PR-URL: #1873 Closes: #1542 Ref: #1152 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: Athan Reines <kgryte@gmail.com>
1 parent 9aef63d commit 2fafc74

17 files changed

+188
-289
lines changed

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

+10-26
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 = ssumkbn2( N, x, 1 );
48+
var v = ssumkbn2( 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 array are accessed at runtime. For example, to compute the sum of every other element in the strided array,
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 = ssumkbn2( N, x, 2 );
65+
var v = ssumkbn2( 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 = ssumkbn2( N, x1, 2 );
79+
var v = ssumkbn2( 4, x1, 2 );
8680
// returns 5.0
8781
```
8882

@@ -94,26 +88,23 @@ 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 = ssumkbn2.ndarray( N, x, 1, 0 );
92+
var v = ssumkbn2.ndarray( 3, x, 1, 0 );
10093
// returns 1.0
10194
```
10295

10396
The function has the following additional parameters:
10497

10598
- **offset**: starting index for `x`.
10699

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
100+
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
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 = ssumkbn2.ndarray( N, x, 2, 1 );
107+
var v = ssumkbn2.ndarray( 4, x, 2, 1 );
117108
// returns 5.0
118109
```
119110

@@ -138,18 +129,11 @@ var v = ssumkbn2.ndarray( N, x, 2, 1 );
138129
<!-- eslint no-undef: "error" -->
139130

140131
```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' );
132+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
133+
var filledarrayBy = require( '@stdlib/array/filled-by' );
144134
var ssumkbn2 = require( '@stdlib/blas/ext/base/ssumkbn2' );
145135

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-
}
136+
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
153137
console.log( x );
154138

155139
var v = ssumkbn2( x.length, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/ssumkbn2/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 ssumkbn2 = require( './../lib/ssumkbn2.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 ssumkbn2 = require( './../lib/ssumkbn2.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/ssumkbn2/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 ssumkbn2 = tryRequire( resolve( __dirname, './../lib/ssumkbn2.native.js' ) )
3636
var opts = {
3737
'skip': ( ssumkbn2 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/ssumkbn2/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 ssumkbn2 = 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 ssumkbn2 = 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/ssumkbn2/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 ssumkbn2 = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
3636
var opts = {
3737
'skip': ( ssumkbn2 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/ssumkbn2/docs/repl.txt

+7-11
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 a second-order iterative Kahan–Babuška algorithm.
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 ] );
39-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
40-
> var stride = 2;
41-
> {{alias}}( N, x, stride )
39+
> {{alias}}( 3, 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 ] );
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}}( 3, 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
using a second-order iterative Kahan–Babuška algorithm and alternative
@@ -85,9 +82,8 @@
8582
1.0
8683

8784
// Using offset parameter:
88-
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
89-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
90-
> {{alias}}.ndarray( N, x, 2, 1 )
85+
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
86+
> {{alias}}.ndarray( 3, x, 2, 1 )
9187
-1.0
9288

9389
See Also

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

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

+6-9
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( './ssumkbn2.native.js' );
2526

2627

@@ -37,20 +38,16 @@ var addon = require( './ssumkbn2.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 ] );
43-
* var N = floor( x.length / 2 );
44-
*
45-
* var v = ssumkbn2( N, x, 2, 1 );
43+
44+
* var v = ssumkbn( 4, x, 2, 1 );
4645
* // returns 5.0
4746
*/
4847
function ssumkbn2( 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)