Skip to content

Commit 412acd6

Browse files
lovelindhonikgryte
andauthored
refactor: update blas/ext/base/ssumpw to follow current project conventions
Closes: #1544 PR-URL: #1673 Ref: #788 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> Signed-off-by: Lovelin <100030865+lovelindhoni@users.noreply.github.com>
1 parent 869def2 commit 412acd6

18 files changed

+172
-285
lines changed

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

+8-22
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
33
@license Apache-2.0
44
5-
Copyright (c) 2020 The Stdlib Authors.
5+
Copyright (c) 2024 The Stdlib Authors.
66
77
Licensed under the Apache License, Version 2.0 (the "License");
88
you may not use this file except in compliance with the License.
@@ -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 compute the sum of 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 compute the sum of 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 = ssumpw( N, x, 2 );
66+
var v = ssumpw( 4, x, 2 );
6967
// returns 5.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 = ssumpw( N, x1, 2 );
80+
var v = ssumpw( 4, x1, 2 );
8681
// returns 5.0
8782
```
8883

@@ -108,12 +103,10 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
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 = ssumpw.ndarray( N, x, 2, 1 );
109+
var v = ssumpw.ndarray( 4, x, 2, 1 );
117110
// returns 5.0
118111
```
119112

@@ -139,18 +132,11 @@ var v = ssumpw.ndarray( N, x, 2, 1 );
139132
<!-- eslint no-undef: "error" -->
140133

141134
```javascript
142-
var randu = require( '@stdlib/random/base/randu' );
143-
var round = require( '@stdlib/math/base/special/round' );
144-
var Float32Array = require( '@stdlib/array/float32' );
135+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
136+
var filledarrayBy = require( '@stdlib/array/filled-by' );
145137
var ssumpw = require( '@stdlib/blas/ext/base/ssumpw' );
146138

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

156142
var v = ssumpw( x.length, x, 1 );

lib/node_modules/@stdlib/blas/ext/base/ssumpw/benchmark/benchmark.js

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -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 ssumpw = require( './../lib/ssumpw.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 ssumpw = require( './../lib/ssumpw.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/ssumpw/benchmark/benchmark.native.js

+5-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -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 ssumpw = tryRequire( resolve( __dirname, './../lib/ssumpw.native.js' ) );
3636
var opts = {
3737
'skip': ( ssumpw 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()*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/ssumpw/benchmark/benchmark.ndarray.js

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -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 ssumpw = 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 ssumpw = 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/ssumpw/benchmark/benchmark.ndarray.native.js

+5-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -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 ssumpw = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
3636
var opts = {
3737
'skip': ( ssumpw 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()*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/ssumpw/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 pairwise summation.
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 pairwise summation and alternative indexing semantics.
@@ -84,9 +81,8 @@
8481
1.0
8582

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

9288
See Also

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

+4-11
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -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 ssumpw = 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( -100.0, 100.0 ) );
3326
console.log( x );
3427

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

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -35,13 +35,11 @@
3535
*
3636
* @example
3737
* var Float32Array = require( '@stdlib/array/float32' );
38-
* var floor = require( '@stdlib/math/base/special/floor' );
3938
* var ssumpw = require( '@stdlib/blas/ext/base/ssumpw' );
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 = ssumpw.ndarray( N, x, 2, 1 );
42+
* var v = ssumpw.ndarray( 4, x, 2, 1 );
4543
* // returns 5.0
4644
*/
4745

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

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2020 The Stdlib Authors.
4+
* Copyright (c) 2024 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -51,12 +51,10 @@ var BLOCKSIZE = 128;
5151
*
5252
* @example
5353
* var Float32Array = require( '@stdlib/array/float32' );
54-
* var floor = require( '@stdlib/math/base/special/floor' );
5554
*
5655
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
57-
* var N = floor( x.length / 2 );
5856
*
59-
* var v = ssumpw( N, x, 2, 1 );
57+
* var v = ssumpw( 4, x, 2, 1 );
6058
* // returns 5.0
6159
*/
6260
function ssumpw( N, x, stride, offset ) {

0 commit comments

Comments
 (0)