Skip to content

Commit 71a78a5

Browse files
vr-varadPlaneshifter
vr-varad
and
Planeshifter
authored
refactor: update blas/ext/base/dcusumkbn2 to follow current project conventions
PR-URL: #2020 Closes: #1473 --------- Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent d761a25 commit 71a78a5

19 files changed

+191
-307
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/dcusumkbn2/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,11 @@ The `N` and `stride` parameters determine which elements in `x` and `y` are acce
6969

7070
```javascript
7171
var Float64Array = require( '@stdlib/array/float64' );
72-
var floor = require( '@stdlib/math/base/special/floor' );
7372

7473
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
7574
var y = new Float64Array( x.length );
7675

77-
var N = floor( x.length / 2 );
76+
var N = 4;
7877

7978
var v = dcusumkbn2( N, 0.0, x, 2, y, 1 );
8079
// y => <Float64Array>[ 1.0, 3.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
@@ -86,7 +85,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
8685

8786
```javascript
8887
var Float64Array = require( '@stdlib/array/float64' );
89-
var floor = require( '@stdlib/math/base/special/floor' );
9088

9189
// Initial arrays...
9290
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
@@ -96,7 +94,7 @@ var y0 = new Float64Array( x0.length );
9694
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
9795
var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
9896

99-
var N = floor( x0.length / 2 );
97+
var N = 4;
10098

10199
dcusumkbn2( N, 0.0, x1, -2, y1, 1 );
102100
// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 6.0, 4.0, 5.0, 0.0 ]
@@ -125,12 +123,11 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
125123

126124
```javascript
127125
var Float64Array = require( '@stdlib/array/float64' );
128-
var floor = require( '@stdlib/math/base/special/floor' );
129126

130127
var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
131128
var y = new Float64Array( x.length );
132129

133-
var N = floor( x.length / 2 );
130+
var N = 4;
134131

135132
dcusumkbn2.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 );
136133
// y => <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 5.0, 1.0, -1.0, 1.0 ]

‎lib/node_modules/@stdlib/blas/ext/base/dcusumkbn2/benchmark/benchmark.js

Lines changed: 9 additions & 11 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' );
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 Float64Array = require( '@stdlib/array/float64' );
2828
var pkg = require( './../package.json' ).name;
2929
var dcusumkbn2 = require( './../lib/dcusumkbn2.js' );
3030

3131

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

3439
/**
@@ -39,15 +44,8 @@ var dcusumkbn2 = require( './../lib/dcusumkbn2.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var y;
43-
var x;
44-
var i;
45-
46-
x = new Float64Array( len );
47-
y = new Float64Array( len );
48-
for ( i = 0; i < x.length; i++ ) {
49-
x[ i ] = ( randu()*20.0 ) - 10.0;
50-
}
47+
var x = filledarrayBy( len, 'float64', rand );
48+
var y = filledarrayBy( len, 'float64', rand );
5149
return benchmark;
5250

5351
function benchmark( b ) {

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

Lines changed: 5 additions & 11 deletions
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 Float64Array = require( '@stdlib/array/float64' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

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

4041

4142
// FUNCTIONS //
@@ -48,15 +49,8 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var y;
53-
var i;
54-
55-
x = new Float64Array( len );
56-
y = new Float64Array( len );
57-
for ( i = 0; i < x.length; i++ ) {
58-
x[ i ] = ( randu()*20.0 ) - 10.0;
59-
}
52+
var x = filledarrayBy( len, 'float64', rand );
53+
var y = filledarrayBy( len, 'float64', rand );
6054
return benchmark;
6155

6256
function benchmark( b ) {

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

Lines changed: 9 additions & 11 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' );
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 Float64Array = require( '@stdlib/array/float64' );
2828
var pkg = require( './../package.json' ).name;
2929
var dcusumkbn2 = require( './../lib/ndarray.js' );
3030

3131

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

3439
/**
@@ -39,15 +44,8 @@ var dcusumkbn2 = require( './../lib/ndarray.js' );
3944
* @returns {Function} benchmark function
4045
*/
4146
function createBenchmark( len ) {
42-
var x;
43-
var y;
44-
var i;
45-
46-
x = new Float64Array( len );
47-
y = new Float64Array( len );
48-
for ( i = 0; i < x.length; i++ ) {
49-
x[ i ] = ( randu()*20.0 ) - 10.0;
50-
}
47+
var x = filledarrayBy( len, 'float64', rand );
48+
var y = filledarrayBy( len, 'float64', rand );
5149
return benchmark;
5250

5351
function benchmark( b ) {

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

Lines changed: 5 additions & 11 deletions
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 Float64Array = require( '@stdlib/array/float64' );
2929
var tryRequire = require( '@stdlib/utils/try-require' );
3030
var pkg = require( './../package.json' ).name;
3131

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

4041

4142
// FUNCTIONS //
@@ -48,15 +49,8 @@ var opts = {
4849
* @returns {Function} benchmark function
4950
*/
5051
function createBenchmark( len ) {
51-
var x;
52-
var y;
53-
var i;
54-
55-
x = new Float64Array( len );
56-
y = new Float64Array( len );
57-
for ( i = 0; i < x.length; i++ ) {
58-
x[ i ] = ( randu()*20.0 ) - 10.0;
59-
}
52+
var x = filledarrayBy( len, 'float64', rand );
53+
var y = filledarrayBy( len, 'float64', rand );
6054
return benchmark;
6155

6256
function benchmark( b ) {

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

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11

22
{{alias}}( N, sum, x, strideX, y, strideY )
3-
Computes the cumulative sum of double-precision floating-point strided array
4-
elements using a second-order iterative Kahan–Babuška algorithm.
3+
Computes the cumulative sum of double-precision floating-point strided
4+
array elements using a second-order iterative Kahan–Babuška algorithm.
55

6-
The `N` and `stride` parameters determine which elements in `x` and `y` are
7-
accessed at runtime.
6+
The `N` and stride parameters determine which elements in the strided
7+
arrays are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use a typed
1010
array view.
@@ -44,31 +44,30 @@
4444
> {{alias}}( x.length, 0.0, x, 1, y, 1 )
4545
<Float64Array>[ 1.0, -1.0, 1.0 ]
4646

47-
// Using `N` and `stride` parameters:
47+
// Using `N` and stride parameters:
4848
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
4949
> y = new {{alias:@stdlib/array/float64}}( x.length );
50-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
51-
> {{alias}}( N, 0.0, x, 2, y, 2 )
50+
> {{alias}}( 3, 0.0, x, 2, y, 2 )
5251
<Float64Array>[ -2.0, 0.0, -1.0, 0.0, 1.0, 0.0 ]
5352

5453
// Using view offsets:
5554
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
5655
> var y0 = new {{alias:@stdlib/array/float64}}( x0.length );
5756
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
5857
> var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*3 );
59-
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
60-
> {{alias}}( N, 0.0, x1, 2, y1, 1 )
58+
> {{alias}}( 3, 0.0, x1, 2, y1, 1 )
6159
<Float64Array>[ -2.0, 0.0, -1.0 ]
6260
> y0
6361
<Float64Array>[ 0.0, 0.0, 0.0, -2.0, 0.0, -1.0 ]
6462

63+
6564
{{alias}}.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY )
66-
Computes the cumulative sum of double-precision floating-point strided array
67-
elements using a second-order iterative Kahan–Babuška algorithm and
65+
Computes the cumulative sum of double-precision floating-point strided
66+
array elements using a second-order iterative Kahan–Babuška algorithm and
6867
alternative indexing semantics.
6968

7069
While typed array views mandate a view offset based on the underlying
71-
buffer, the `offset` parameter supports indexing semantics based on a
70+
buffer, the offset parameters support indexing semantics based on a
7271
starting index.
7372

7473
Parameters
@@ -113,8 +112,7 @@
113112
// Advanced indexing:
114113
> x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
115114
> y = new {{alias:@stdlib/array/float64}}( x.length );
116-
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
117-
> {{alias}}.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 )
115+
> {{alias}}.ndarray( 3, 0.0, x, 2, 1, y, -1, y.length-1 )
118116
<Float64Array>[ 0.0, 0.0, 0.0, -1.0, 0.0, -2.0 ]
119117

120118
See Also

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

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,14 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
23-
var Float64Array = require( '@stdlib/array/float64' );
21+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
22+
var filledarrayBy = require( '@stdlib/array/filled-by' );
2423
var dcusumkbn2 = require( './../lib' );
2524

26-
var y;
27-
var x;
28-
var i;
29-
30-
x = new Float64Array( 10 );
31-
y = new Float64Array( x.length );
32-
for ( i = 0; i < x.length; i++ ) {
33-
x[ i ] = round( randu()*100.0 );
34-
}
25+
var x = filledarrayBy( 10, 'float64', discreteUniform( 0, 100 ) );
3526
console.log( x );
27+
28+
var y = filledarrayBy( x.length, 'float64', discreteUniform( 0, 10 ) );
3629
console.log( y );
3730

3831
dcusumkbn2( x.length, 0.0, x, 1, y, -1 );

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,11 @@
3636
*
3737
* @example
3838
* var Float64Array = require( '@stdlib/array/float64' );
39-
* var floor = require( '@stdlib/math/base/special/floor' );
4039
* var dcusumkbn2 = require( '@stdlib/blas/ext/base/dcusumkbn2' );
4140
*
4241
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
4342
* var y = new Float64Array( x.length );
44-
* var N = floor( x.length / 2 );
43+
* var N = 4;
4544
*
4645
* dcusumkbn2.ndarray( N, 0.0, x, 2, 1, y, 1, 0 );
4746
* // y => <Float64Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]

‎lib/node_modules/@stdlib/blas/ext/base/dcusumkbn2/lib/ndarray.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
4848
*
4949
* @example
5050
* var Float64Array = require( '@stdlib/array/float64' );
51-
* var floor = require( '@stdlib/math/base/special/floor' );
5251
*
5352
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
5453
* var y = new Float64Array( x.length );
55-
* var N = floor( x.length / 2 );
54+
* var N = 4;
5655
*
5756
* var v = dcusumkbn2( N, 0.0, x, 2, 1, y, 1, 0 );
5857
* // returns <Float64Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]

‎lib/node_modules/@stdlib/blas/ext/base/dcusumkbn2/lib/ndarray.native.js

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020

2121
// MODULES //
2222

23-
var Float64Array = require( '@stdlib/array/float64' );
23+
var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
24+
var offsetView = require( '@stdlib/strided/base/offset-view' );
2425
var addon = require( './dcusumkbn2.native.js' );
2526

2627

@@ -41,26 +42,21 @@ var addon = require( './dcusumkbn2.native.js' );
4142
*
4243
* @example
4344
* var Float64Array = require( '@stdlib/array/float64' );
44-
* var floor = require( '@stdlib/math/base/special/floor' );
45-
*
4645
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
4746
* var y = new Float64Array( x.length );
48-
* var N = floor( x.length / 2 );
47+
* var N = 4
4948
*
5049
* var v = dcusumkbn2( N, 0.0, x, 2, 1, y, 1, 0 );
5150
* // returns <Float64Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]
5251
*/
5352
function dcusumkbn2( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {
5453
var viewX;
5554
var viewY;
56-
if ( strideX < 0 ) {
57-
offsetX += (N-1) * strideX;
58-
}
59-
if ( strideY < 0 ) {
60-
offsetY += (N-1) * strideY;
61-
}
62-
viewX = new Float64Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offsetX), x.length-offsetX ); // eslint-disable-line max-len
63-
viewY = new Float64Array( y.buffer, y.byteOffset+(y.BYTES_PER_ELEMENT*offsetY), y.length-offsetY ); // eslint-disable-line max-len
55+
offsetX = minViewBufferIndex( N, strideX, offsetX );
56+
offsetY = minViewBufferIndex( N, strideY, offsetY );
57+
58+
viewX = offsetView( x, offsetX );
59+
viewY = offsetView( y, offsetY );
6460
addon( N, sum, viewX, strideX, viewY, strideY );
6561
return y;
6662
}

0 commit comments

Comments
 (0)