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/dapxsumors to follow current project conventions #1993

Merged
merged 27 commits into from
Mar 24, 2024
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
7e74166
added readme
ShivamAhir Mar 22, 2024
c0baba9
added benchmark.js
ShivamAhir Mar 22, 2024
40cd7f6
added benchmark-native.js
ShivamAhir Mar 22, 2024
a7865b9
added benchmark-ndarrays.js
ShivamAhir Mar 22, 2024
1639446
added benchmark-ndarrays-native.js
ShivamAhir Mar 22, 2024
de27851
added repl.txt
ShivamAhir Mar 22, 2024
c9f1c64
added example/index.js
ShivamAhir Mar 22, 2024
af837d6
added include.gypi
ShivamAhir Mar 22, 2024
c23ab12
added lib/index.js
ShivamAhir Mar 22, 2024
84a20a3
added lib/ndarray.js
ShivamAhir Mar 22, 2024
e129d4f
added lib/ndarray-native.js
ShivamAhir Mar 22, 2024
2fc7eb4
added manifest.json
ShivamAhir Mar 22, 2024
665ccb0
added test/test-ndarray.js
ShivamAhir Mar 22, 2024
f0e3d47
added test/test-ndarray-native.js
ShivamAhir Mar 22, 2024
8a099aa
added test/test-dapxsumors.js
ShivamAhir Mar 22, 2024
24e4afe
added test/test-dapxsumors-native.js
ShivamAhir Mar 22, 2024
b508f8c
added addon.c
ShivamAhir Mar 22, 2024
7487c6f
deleted addon.cpp
ShivamAhir Mar 22, 2024
60f018c
docs: resolve suggestion by mentor
ShivamAhir Mar 24, 2024
4cc5423
Update README.md
ShivamAhir Mar 24, 2024
efb1224
docs: added @ and - in manifest.json
ShivamAhir Mar 24, 2024
b6b2e4b
fix: add benchmark and example to manifest
ShivamAhir Mar 24, 2024
741fe24
fix: add benchmark and example to manifest
ShivamAhir Mar 24, 2024
e9ed858
style: add extra empty line
Planeshifter Mar 24, 2024
585b66b
style: fix indentation
Planeshifter Mar 24, 2024
26f0ffe
style: add extra empty line
Planeshifter Mar 24, 2024
48f5f8b
docs: update example
Planeshifter Mar 24, 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
28 changes: 7 additions & 21 deletions lib/node_modules/@stdlib/blas/ext/base/dapxsumors/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 [`Float64Array`][@stdlib/array/float64].
- **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 Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );

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

var v = dapxsumors( N, 5.0, x, 2 );
var v = dapxsumors( 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 Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );

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

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

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

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

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

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

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

Expand All @@ -139,18 +132,11 @@ var v = dapxsumors.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 Float64Array = require( '@stdlib/array/float64' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var dapxsumors = require( '@stdlib/blas/ext/base/dapxsumors' );

var x;
var i;

x = new Float64Array( 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 = dapxsumors( x.length, 5.0, x, 1 );
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 uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float64Array = require( '@stdlib/array/float64' );
var pkg = require( './../package.json' ).name;
var dapxsumors = require( './../lib/dapxsumors.js' );

Planeshifter marked this conversation as resolved.
Show resolved Hide resolved

// VARIABLES //

var rand = uniform( -100.0, 100.0 );


// FUNCTIONS //

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

x = new Float64Array( len );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = filledarrayBy( len, 'float64', 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 uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float64Array = require( '@stdlib/array/float64' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

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


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

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

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

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

Planeshifter marked this conversation as resolved.
Show resolved Hide resolved
// VARIABLES //

Check failure on line 31 in lib/node_modules/@stdlib/blas/ext/base/dapxsumors/benchmark/benchmark.ndarray.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Header comment must be preceded by one additional empty line

var rand = uniform( -100.0, 100.0 );


// FUNCTIONS //

Expand All @@ -39,13 +43,7 @@
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = new Float64Array( len );
for ( i = 0; i < x.length; i++ ) {
x[ i ] = ( randu()*20.0 ) - 10.0;
}
var x = filledarrayBy( len, 'float64', 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 uniform = require( '@stdlib/random/base/uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var Float64Array = require( '@stdlib/array/float64' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

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


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

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

function benchmark( b ) {
Expand Down
18 changes: 7 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/dapxsumors/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Adds a constant to each double-precision floating-point strided array
element and computes the sum using ordinary recursive summation.

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 @@ -39,18 +39,15 @@

// Using `N` and `stride` parameters:
> x = new {{alias:@stdlib/array/float64}}( [ -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/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
> var x1 = new {{alias:@stdlib/array/float64}}( 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 )
14.0
> {{alias}}( 2, 5.0, x1, 2 )
10
Planeshifter marked this conversation as resolved.
Show resolved Hide resolved


{{alias}}.ndarray( N, alpha, x, stride, offset )
Adds a constant to each double-precision floating-point strided array
Expand Down Expand Up @@ -92,8 +89,7 @@

// Using offset parameter:
> var x = new {{alias:@stdlib/array/float64}}( [ 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 )
> {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
14.0

See Also
Expand Down
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 Float64Array = require( '@stdlib/array/float64' );
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var filledarrayBy = require( '@stdlib/array/filled-by' );
var dapxsumors = require( './../lib' );

var x;
var i;

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

var v = dapxsumors( 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
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,17 @@
* var dapxsumors = require( '@stdlib/blas/ext/base/dapxsumors' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var N = x.length;
*
* var v = dapxsumors( N, 5.0, x, 1 );
* var v = dapxsumors( 3, 5.0, x, 1 );
* // returns 16.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var floor = require( '@stdlib/math/base/special/floor' );
* var dapxsumors = require( '@stdlib/blas/ext/base/dapxsumors' );
*
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
* var N = floor( x.length / 2 );
*
* var v = dapxsumors.ndarray( N, 5.0, x, 2, 1 );
* var v = dapxsumors.ndarray( 4, 5.0, x, 2, 1 );
* // returns 25.0
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,10 @@
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var floor = require( '@stdlib/math/base/special/floor' );
*
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
* var N = floor( x.length / 2 );
*
* var v = dapxsumors( N, 5.0, x, 2, 1 );
* var v = dapxsumors( 4, 5.0, x, 2, 1 );
* // returns 25.0
*/
function dapxsumors( 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 Float64Array = require( '@stdlib/array/float64' );
var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
var offsetView = require( '@stdlib/strided/base/offset-view' );
var addon = require( './dapxsumors.native.js' );


Expand All @@ -38,20 +39,16 @@ var addon = require( './dapxsumors.native.js' );
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var floor = require( '@stdlib/math/base/special/floor' );
*
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
* var N = floor( x.length / 2 );
*
* var v = dapxsumors( N, 5.0, x, 2, 1 );
* var v = dapxsumors( 4, 5.0, x, 2, 1 );
* // returns 25.0
*/
function dapxsumors( N, alpha, x, stride, offset ) {
var view;
if ( stride < 0 ) {
offset += (N-1) * stride;
}
view = new Float64Array( 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