gnansumkbn

Compute the sum of a one-dimensional ndarray, ignoring NaN values and using an improved Kahan–Babuška algorithm.

Installation

npm install @stdlib/blas-ext-base-ndarray-gnansumkbn

Usage

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

gnansumkbn( arrays )

Computes the sum of a one-dimensional ndarray, ignoring NaN values and using an improved Kahan–Babuška algorithm.

var ndarray = require( '@stdlib/ndarray-base-ctor' );

var xbuf = [ 1.0, -2.0, NaN, 2.0 ];
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );

var v = gnansumkbn( [ x ] );
// returns 1.0

The function has the following parameters:

• arrays: array-like object containing a one-dimensional input ndarray.

Notes

• If provided an empty one-dimensional ndarray, the function returns 0.0.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var gnansumkbn = require( '@stdlib/blas-ext-base-ndarray-gnansumkbn' );

var xbuf = discreteUniform( 10, -50, 50, {
    'dtype': 'generic'
});
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

var v = gnansumkbn( [ x ] );
console.log( v );

References

• Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." Zeitschrift Für Angewandte Mathematik Und Mechanik 54 (1): 39–51. doi:10.1002/zamm.19740540106.

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-2026. The Stdlib Authors.