Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 9 additions & 10 deletions lib/node_modules/@stdlib/blas/ext/base/dnanasum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,18 @@ Computes the sum of absolute values ([_L1_ norm][l1norm]) of double-precision fl
var Float64Array = require( '@stdlib/array/float64' );

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

var v = dnanasum( N, x, 1 );
var v = dnanasum( x.length, x, 1 );
// returns 5.0
```

The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **strideX**: index increment for `x`.
- **strideX**: stride length.

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of absolute values ([_L1_ norm][l1norm]) for every other element in the strided array,
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of absolute values ([_L1_ norm][l1norm]) for every other element:

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -111,9 +110,9 @@ var v = dnanasum.ndarray( 4, x, 1, 0 );

The function has the following additional parameters:

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

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 calculate the sum of absolute values ([_L1_ norm][l1norm]) for every other value in the strided array 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 calculate the sum of absolute values ([_L1_ norm][l1norm]) for every other value in the strided array starting from the second value:

```javascript
var Float64Array = require( '@stdlib/array/float64' );
Expand Down Expand Up @@ -152,7 +151,7 @@ var Float64Array = require( '@stdlib/array/float64' );
var dnanasum = require( '@stdlib/blas/ext/base/dnanasum' );

function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
if ( bernoulli( 0.5 ) < 1 ) {
return discreteUniform( 0, 100 );
}
return NaN;
Expand Down Expand Up @@ -210,7 +209,7 @@ The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **strideX**: `[in] CBLAS_INT` stride length.

```c
double stdlib_strided_dnanasum( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
Expand All @@ -231,8 +230,8 @@ The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
- **strideX**: `[in] CBLAS_INT` stride length.
- **offsetX**: `[in] CBLAS_INT` starting index.

```c
double stdlib_strided_dnanasum_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ var dnanasum = require( './../lib/dnanasum.js' );

// FUNCTIONS //

/**
* Returns a random number.
*
* @private
* @returns {number} random number
*/
function rand() {
if ( bernoulli( 0.5 ) < 1 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

/**
* Creates a benchmark function.
*
Expand All @@ -43,13 +56,6 @@ function createBenchmark( len ) {
var x = filledarrayBy( len, 'float64', rand );
return benchmark;

function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

function benchmark( b ) {
var v;
var i;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ var opts = {

// FUNCTIONS //

/**
* Returns a random number.
*
* @private
* @returns {number} random number
*/
function rand() {
if ( bernoulli( 0.5 ) < 1 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

/**
* Creates a benchmark function.
*
Expand All @@ -52,13 +65,6 @@ function createBenchmark( len ) {
var x = filledarrayBy( len, 'float64', rand );
return benchmark;

function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

function benchmark( b ) {
var v;
var i;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,19 @@ var dnanasum = require( './../lib/ndarray.js' );

// FUNCTIONS //

/**
* Returns a random number.
*
* @private
* @returns {number} random number
*/
function rand() {
if ( bernoulli( 0.5 ) < 1 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

/**
* Creates a benchmark function.
*
Expand All @@ -43,13 +56,6 @@ function createBenchmark( len ) {
var x = filledarrayBy( len, 'float64', rand );
return benchmark;

function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

function benchmark( b ) {
var v;
var i;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@ var opts = {

// FUNCTIONS //

/**
* Returns a random number.
*
* @private
* @returns {number} random number
*/
function rand() {
if ( bernoulli( 0.5 ) < 1 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

/**
* Creates a benchmark function.
*
Expand All @@ -52,13 +65,6 @@ function createBenchmark( len ) {
var x = filledarrayBy( len, 'float64', rand );
return benchmark;

function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
return uniform( -10.0, 10.0 );
}
return NaN;
}

function benchmark( b ) {
var v;
var i;
Expand Down
10 changes: 5 additions & 5 deletions lib/node_modules/@stdlib/blas/ext/base/dnanasum/docs/repl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Computes the sum of absolute values (L1 norm) of double-precision floating-
point strided array elements, ignoring `NaN` values.

The `N` and stride parameters determine which elements in the strided
array 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 All @@ -20,7 +20,7 @@
Input array.

strideX: integer
Index increment.
Stride length.

Returns
-------
Expand All @@ -34,7 +34,7 @@
> {{alias}}( x.length, x, 1 )
5.0

// Using `N` and `stride` parameters:
// Using `N` and stride parameters:
> x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );
> {{alias}}( 4, x, 2 )
5.0
Expand Down Expand Up @@ -64,7 +64,7 @@
Input array.

strideX: integer
Index increment.
Stride length.

offsetX: integer
Starting index.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ var filledarrayBy = require( '@stdlib/array/filled-by' );
var dnanasum = require( './../lib' );

function rand() {
if ( bernoulli( 0.8 ) > 0 ) {
if ( bernoulli( 0.5 ) < 1 ) {
return discreteUniform( 0, 100 );
}
return NaN;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,12 @@ var dnanasumors = require( '@stdlib/blas/ext/base/dnanasumors' ).ndarray;
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float64Array} x - input array
* @param {integer} strideX - index increment
* @param {integer} strideX - stride length
* @param {NonNegativeInteger} offsetX - starting index
* @returns {number} sum
*
* @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, NaN, NaN ] );
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ var addon = require( './../src/addon.node' );
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float64Array} x - input array
* @param {integer} strideX - index increment
* @param {integer} strideX - stride length
* @param {NonNegativeInteger} offsetX - starting index
* @returns {number} sum
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/dnanasum/src/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ double API_SUFFIX(stdlib_strided_dnanasum)( const CBLAS_INT N, const double *X,
*
* @param N number of indexed elements
* @param X input array
* @param strideX index increment
* @param strideX stride length
* @param offsetX starting index
* @return output value
*/
Expand Down