Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: update blas/ext/base/sapxsum to follow current project conventions #1850

Merged
merged 24 commits into from
Mar 21, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e5a3c8e
refactor: update blas/ext/base/sapxsum to follow current project conv…
gunjjoshi Mar 12, 2024
dd61193
Update repl.txt
gunjjoshi Mar 12, 2024
993574b
chore: apply suggestions from code review
Pranavchiku Mar 12, 2024
d5aeba3
Update lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/index.js
gunjjoshi Mar 13, 2024
9f6b3e4
Update lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarr…
gunjjoshi Mar 13, 2024
c704c27
Update test.sapxsum.native.js
gunjjoshi Mar 13, 2024
c34effa
Update test.ndarray.js
gunjjoshi Mar 13, 2024
3f55a99
Update test.ndarray.native.js
gunjjoshi Mar 13, 2024
ac5899a
Update test.sapxsum.js
gunjjoshi Mar 13, 2024
8d890b2
Update ndarray.js
gunjjoshi Mar 13, 2024
140145a
Update ndarray.native.js
gunjjoshi Mar 13, 2024
8a14b5d
Update addon.c
gunjjoshi Mar 13, 2024
82f7cea
Update test.ndarray.js
gunjjoshi Mar 13, 2024
fd38276
Update test.ndarray.native.js
gunjjoshi Mar 13, 2024
84bd77d
Update test.sapxsum.js
gunjjoshi Mar 13, 2024
5d03ac9
Update test.sapxsum.native.js
gunjjoshi Mar 13, 2024
8d12d1d
Update test.ndarray.native.js
gunjjoshi Mar 13, 2024
b010fd3
Update repl.txt
gunjjoshi Mar 13, 2024
382c324
Apply suggestions from code review
kgryte Mar 21, 2024
c7e7503
Apply suggestions from code review
kgryte Mar 21, 2024
7429e29
Apply suggestions from code review
kgryte Mar 21, 2024
7851f59
Apply suggestions from code review
kgryte Mar 21, 2024
d5c4bd5
refactor: modified manifest.json
gunjjoshi Mar 21, 2024
b721dba
Apply suggestions from code review
kgryte Mar 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 8 additions & 25 deletions lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,14 @@ The function has the following parameters:
- **x**: input [`Float32Array`][@stdlib/array/float32].
- **stride**: index increment for `x`.

The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to access every other element in `x`,
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element in `x`,

```javascript
var Float32Array = require( '@stdlib/array/float32' );
var floor = require( '@stdlib/math/base/special/floor' );

var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
var N = floor( x.length / 2 );

var v = sapxsum( N, 5.0, x, 2 );
var v = sapxsum( 4, 5.0, x, 2 );
// returns 25.0
```

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

```javascript
var Float32Array = require( '@stdlib/array/float32' );
var floor = require( '@stdlib/math/base/special/floor' );

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

var N = floor( x0.length / 2 );

var v = sapxsum( N, 5.0, x1, 2 );
var v = sapxsum( 4, 5.0, x1, 2 );
// returns 25.0
```

Expand All @@ -104,16 +99,14 @@ The function has the following additional parameters:

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

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 every other value in `x` starting from the second value
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 every other value in `x` starting from the second value

```javascript
var Float32Array = require( '@stdlib/array/float32' );
var floor = require( '@stdlib/math/base/special/floor' );

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

var v = sapxsum.ndarray( N, 5.0, x, 2, 1 );
var v = sapxsum.ndarray( 4, 5.0, x, 2, 1 );
// returns 25.0
```

Expand All @@ -138,22 +131,12 @@ var v = sapxsum.ndarray( N, 5.0, x, 2, 1 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var Float32Array = require( '@stdlib/array/float32' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' );

var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = round( randu()*100.0 );
}
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
console.log( x );

var v = sapxsum( x.length, 5.0, x, 1 );
console.log( v );
```

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,19 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float32Array = require( '@stdlib/array/float32' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var pkg = require( './../package.json' ).name;
var sapxsum = require( './../lib/sapxsum.js' );


// VARIABLES //

var rand = uniform( -10.0, 10.0 );


// FUNCTIONS //

/**
Expand All @@ -39,13 +44,7 @@ var sapxsum = require( './../lib/sapxsum.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

function benchmark( b ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float32Array = require( '@stdlib/array/float32' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -36,6 +36,7 @@ var sapxsum = tryRequire( resolve( __dirname, './../lib/sapxsum.native.js' ) );
var opts = {
'skip': ( sapxsum instanceof Error )
};
var rand = uniform( -10.0, 10.0 );


// FUNCTIONS //
Expand All @@ -48,13 +49,7 @@ var opts = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

function benchmark( b ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,19 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float32Array = require( '@stdlib/array/float32' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var pkg = require( './../package.json' ).name;
var sapxsum = require( './../lib/ndarray.js' );


// VARIABLES //

var rand = uniform( -10.0, 10.0 );


// FUNCTIONS //

/**
Expand All @@ -39,13 +44,7 @@ var sapxsum = require( './../lib/ndarray.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

function benchmark( b ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float32Array = require( '@stdlib/array/float32' );
var uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -36,6 +36,7 @@ var sapxsum = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
var opts = {
'skip': ( sapxsum instanceof Error )
};
var rand = uniform( -10.0, 10.0 );


// FUNCTIONS //
Expand All @@ -48,13 +49,7 @@ var opts = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

function benchmark( b ) {
Expand Down
22 changes: 9 additions & 13 deletions lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Adds a constant to each single-precision floating-point strided array
element and computes the sum.

The `N` and `stride` parameters determine which elements in `x` are accessed
at runtime.
The `N` and stride parameters determine which elements in the strided
array are accessed at runtime.

Indexing is relative to the first index. To introduce an offset, use a typed
array view.
Expand Down Expand Up @@ -37,27 +37,24 @@
> {{alias}}( x.length, 5.0, x, 1 )
16.0

// Using `N` and `stride` parameters:
// Using `N` and stride parameters:
> x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> var stride = 2;
> {{alias}}( N, 5.0, x, stride )
> {{alias}}( 3, 5.0, x, 2 )
16.0

// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
> var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> stride = 2;
> {{alias}}( N, 5.0, x1, stride )
> {{alias}}( 3, 5.0, x1, 2 )
14.0


{{alias}}.ndarray( N, alpha, x, stride, offset )
Adds a constant to each single-precision floating-point strided array
element and computes the sum using alternative indexing semantics.

While typed array views mandate a view offset based on the underlying
buffer, the `offset` parameter supports indexing semantics based on a
buffer, the offset parameter supports indexing semantics based on a
starting index.

Parameters
Expand Down Expand Up @@ -90,9 +87,8 @@
16.0

// Using offset parameter:
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, 5.0, x, 2, 1 )
> x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
Pranavchiku marked this conversation as resolved.
Show resolved Hide resolved
> {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
14.0

See Also
Expand Down
13 changes: 3 additions & 10 deletions lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,11 @@

'use strict';

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var Float32Array = require( '@stdlib/array/float32' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var sapxsum = require( './../lib' );

var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = round( randu()*100.0 );
}
var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) );
console.log( x );

var v = sapxsum( x.length, 5.0, x, 1 );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

# Source files:
'src_files': [
'<(src_dir)/addon.cpp',
'<(src_dir)/addon.c',
'<!@(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 ] ); }")',
],

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,11 @@
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var floor = require( '@stdlib/math/base/special/floor' );
* var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' );
*
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
* var N = floor( x.length / 2 );
*
* var v = sapxsum.ndarray( N, 5.0, x, 2, 1 );
* var v = sapxsum.ndarray( 4, 5.0, x, 2, 1 );
* // returns 25.0
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,10 @@ var sapxsumkbn = require( '@stdlib/blas/ext/base/sapxsumkbn' ).ndarray;
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var floor = require( '@stdlib/math/base/special/floor' );
*
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
* var N = floor( x.length / 2 );
*
* var v = sapxsum( N, 5.0, x, 2, 1 );
* var v = sapxsum( 4, 5.0, x, 2, 1 );
* // returns 25.0
*/
function sapxsum( N, alpha, x, stride, offset ) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@

// MODULES //

var Float32Array = require( '@stdlib/array/float32' );
var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
var offsetView = require( '@stdlib/strided/base/offset-view' );
var addon = require( './sapxsum.native.js' );


Expand All @@ -38,20 +39,16 @@ var addon = require( './sapxsum.native.js' );
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var floor = require( '@stdlib/math/base/special/floor' );
*
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
* var N = floor( x.length / 2 );
*
* var v = sapxsum( N, 5.0, x, 2, 1 );
* var v = sapxsum( 3, 5.0, x, 2, 1 );
kgryte marked this conversation as resolved.
Show resolved Hide resolved
* // returns 25.0
*/
function sapxsum( N, alpha, x, stride, offset ) {
var view;
if ( stride < 0 ) {
offset += (N-1) * stride;
}
view = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len
offset = minViewBufferIndex( N, stride, offset );
view = offsetView( x, offset );
return addon( N, alpha, view, stride );
}

Expand Down
Loading
Loading