dnannsumpw

Calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation.

Installation

npm install @stdlib/blas-ext-base-dnannsumpw

Usage

var dnannsumpw = require( '@stdlib/blas-ext-base-dnannsumpw' );

dnannsumpw( N, x, strideX, out, strideOut )

Computes the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation.

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var out = new Float64Array( 2 );

var v = dnannsumpw( x.length, x, 1, out, 1 );
// returns <Float64Array>[ 1.0, 3 ]

The function has the following parameters:

• N: number of indexed elements.
• x: input Float64Array.
• strideX: index increment for the strided array.
• out: output Float64Array whose first element is the sum and whose second element is the number of non-NaN elements.
• strideOut: index increment for out.

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

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 1.0, 2.0, NaN, -7.0, NaN, 3.0, 4.0, 2.0 ] );
var out = new Float64Array( 2 );

var v = dnannsumpw( 4, x, 2, out, 1 );
// returns <Float64Array>[ 5.0, 2 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Float64Array = require( '@stdlib/array-float64' );

var x0 = new Float64Array( [ 2.0, 1.0, NaN, -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 out0 = new Float64Array( 4 );
var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at 3rd element

var v = dnannsumpw( 4, x1, 2, out1, 1 );
// returns <Float64Array>[ 5.0, 4 ]

dnannsumpw.ndarray( N, x, strideX, offsetX, out, strideOut, offsetOut )

Computes the sum of double-precision floating-point strided array elements, ignoring NaN values and using pairwise summation and alternative indexing semantics.

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var out = new Float64Array( 2 );

var v = dnannsumpw.ndarray( x.length, x, 1, 0, out, 1, 0 );
// returns <Float64Array>[ 1.0, 3 ]

The function has the following additional parameters:

• offsetX: starting index for the strided array.
• offsetOut: starting index for out.

While 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 every other value in the strided array starting from the second value

var Float64Array = require( '@stdlib/array-float64' );

var x = new Float64Array( [ 2.0, 1.0, NaN, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
var out = new Float64Array( 4 );

var v = dnannsumpw.ndarray( 4, x, 2, 1, out, 2, 1 );
// returns <Float64Array>[ 0.0, 5.0, 0.0, 4 ]

Notes

• If N <= 0, both functions return a sum equal to 0.0.
• In general, pairwise summation is more numerically stable than ordinary recursive summation (i.e., "simple" summation), with slightly worse performance. While not the most numerically stable summation technique (e.g., compensated summation techniques such as the Kahan–Babuška-Neumaier algorithm are generally more numerically stable), pairwise summation strikes a reasonable balance between numerical stability and performance. If either numerical stability or performance is more desirable for your use case, consider alternative summation techniques.

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var bernoulli = require( '@stdlib/random-base-bernoulli' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var Float64Array = require( '@stdlib/array-float64' );
var dnannsumpw = require( '@stdlib/blas-ext-base-dnannsumpw' );

function rand() {
    if ( bernoulli( 0.8 ) > 0 ) {
        return discreteUniform( 0, 100 );
    }
    return NaN;
}

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

var out = new Float64Array( 2 );
dnannsumpw( x.length, x, 1, out, 1 );
console.log( out );

References

• Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." SIAM Journal on Scientific Computing 14 (4): 783–99. doi:10.1137/0914050.

See Also

• @stdlib/blas-ext/base/dnannsum: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values.
• @stdlib/blas-ext/base/dnannsumkbn: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using an improved Kahan–Babuška algorithm.
• @stdlib/blas-ext/base/dnannsumkbn2: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.
• @stdlib/blas-ext/base/dnannsumors: calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using ordinary recursive summation.
• @stdlib/blas-ext/base/dsumpw: calculate the sum of double-precision floating-point strided array elements using pairwise summation.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.