Skip to content

Commit

Permalink
refactor: blas/ext/base/snansumkbn2 according to current project co…
Browse files Browse the repository at this point in the history 
…nventions

PR-URL: #3002
Closes: #1530
Ref: #1152

Co-authored-by: Gururaj Gurram <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
@gururaj1512 @Planeshifter
3 people authored Oct 12, 2024
1 parent f0ab00b commit efbff47
Show file tree
Hide file tree
Showing 20 changed files with 205 additions and 299 deletions.
42 changes: 15 additions & 27 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,8 @@ Computes the sum of single-precision floating-point strided array elements, igno
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
var N = x.length;

var v = snansumkbn2( N, x, 1 );
var v = snansumkbn2( 4, x, 1 );
// returns 1.0
```

Expand All @@ -56,16 +55,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 compute the sum of every other element in `x`,
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`,

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

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

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

Expand All @@ -75,14 +72,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, NaN, -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 = snansumkbn2( N, x1, 2 );
var v = snansumkbn2( 4, x1, 2 );
// returns 5.0
```

Expand All @@ -94,9 +88,8 @@ Computes the sum of single-precision floating-point strided array elements, igno
var Float32Array = require( '@stdlib/array/float32' );

var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
var N = x.length;

var v = snansumkbn2.ndarray( N, x, 1, 0 );
var v = snansumkbn2.ndarray( 4, x, 1, 0 );
// returns 1.0
```

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

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

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

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

Expand All @@ -138,22 +129,19 @@ var v = snansumkbn2.ndarray( N, 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' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var snansumkbn2 = require( '@stdlib/blas/ext/base/snansumkbn2' );

var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = round( randu()*100.0 );
function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return discreteUniform( 0, 100 );
}
return NaN;
}

var x = filledarrayBy( 10, 'float32', rand );
console.log( x );

var v = snansumkbn2( x.length, x, 1 );
Expand Down
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/benchmark/benchmark.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
var pkg = require( './../package.json' ).name;
var snansumkbn2 = require( './../lib/snansumkbn2.js' );

Expand All @@ -39,18 +40,15 @@ var snansumkbn2 = require( './../lib/snansumkbn2.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = ( randu()*10.0 ) - 20.0;
function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}
return benchmark;

function benchmark( b ) {
var v;
Expand Down
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/benchmark/benchmark.native.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -48,18 +49,15 @@ var opts = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = ( randu()*10.0 ) - 20.0;
function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}
return benchmark;

function benchmark( b ) {
var v;
Expand Down
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/benchmark/benchmark.ndarray.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
var pkg = require( './../package.json' ).name;
var snansumkbn2 = require( './../lib/ndarray.js' );

Expand All @@ -39,18 +40,15 @@ var snansumkbn2 = require( './../lib/ndarray.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = ( randu()*10.0 ) - 20.0;
function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}
return benchmark;

function benchmark( b ) {
var v;
Expand Down
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/benchmark/benchmark.ndarray.native.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
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 Float32Array = require( '@stdlib/array/float32' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;

Expand All @@ -48,18 +49,15 @@ var opts = {
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;
var x = filledarrayBy( len, 'float32', rand );
return benchmark;

x = new Float32Array( len );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = ( randu()*10.0 ) - 20.0;
function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}
return benchmark;

function benchmark( b ) {
var v;
Expand Down
20 changes: 9 additions & 11 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/docs/repl.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
ignoring `NaN` values and using a second-order iterative Kahan–Babuška
algorithm.

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

This comment has been minimized.

Sign in to view

Copy link
@kgryte

kgryte Oct 17, 2024

Member

@Planeshifter The line wrapping is off here. Should be

    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.
array are accessed at runtime.

Indexing is relative to the first index. To introduce an offset, use a typed
array view.
Indexing is relative to the first index. To introduce an offset,
use a typed array view.

If `N <= 0`, the function returns `0.0`.

Expand All @@ -35,21 +35,20 @@
> {{alias}}( x.length, x, 1 )
1.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, NaN, NaN ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> var stride = 2;
> {{alias}}( N, x, stride )
> {{alias}}( 4, x, stride )
1.0

// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
> 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, x1, stride )
> {{alias}}( 4, x1, stride )
-1.0


{{alias}}.ndarray( N, x, stride, offset )
Computes the sum of single-precision floating-point strided array elements,
ignoring `NaN` values and using a second-order iterative Kahan–Babuška
Expand Down Expand Up @@ -87,8 +86,7 @@

// Using offset parameter:
> var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, x, 2, 1 )
> {{alias}}.ndarray( 4, x, 2, 1 )
-1.0

See Also
Expand Down
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/examples/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,19 @@

'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' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var snansumkbn2 = require( './../lib' );

var x;
var i;

x = new Float32Array( 10 );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = round( randu()*100.0 );
function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return discreteUniform( 0, 100 );
}
return NaN;
}

var x = filledarrayBy( 10, 'float32', rand );
console.log( x );

var v = snansumkbn2( x.length, x, 1 );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/include.gypi
View file
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
7 changes: 2 additions & 5 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/lib/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,17 @@
* var snansumkbn2 = require( '@stdlib/blas/ext/base/snansumkbn2' );
*
* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
* var N = x.length;
*
* var v = snansumkbn2( N, x, 1 );
* var v = snansumkbn2( 4, x, 1 );
* // returns 1.0
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var floor = require( '@stdlib/math/base/special/floor' );
* var snansumkbn2 = require( '@stdlib/blas/ext/base/snansumkbn2' );
*
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
* var N = floor( x.length / 2 );
*
* var v = snansumkbn2.ndarray( N, x, 2, 1 );
* var v = snansumkbn2.ndarray( 5, x, 2, 1 );
* // returns 5.0
*/

Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/ext/base/snansumkbn2/lib/ndarray.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
*
* @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, NaN, NaN ] );
* var N = floor( x.length / 2 );
*
* var v = snansumkbn2( N, x, 2, 1 );
* var v = snansumkbn2( 5, x, 2, 1 );
* // returns 5.0
*/
function snansumkbn2( N, x, stride, offset ) {
Expand Down
Loading

1 comment on commit efbff47

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
blas/ext/base/snansumkbn2 $\color{green}461/461$
$\color{green}+100.00\%$ 		$\color{green}44/44$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}461/461$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.