@stdlib/blas-ext-base-ndarray-dnansumkbn2
v0.1.1
Published
Compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
Readme
dnansumkbn2
Compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring
NaNvalues and using a second-order iterative Kahan–Babuška algorithm.
Installation
npm install @stdlib/blas-ext-base-ndarray-dnansumkbn2Usage
var dnansumkbn2 = require( '@stdlib/blas-ext-base-ndarray-dnansumkbn2' );dnansumkbn2( arrays )
Computes the sum of a one-dimensional double-precision floating-point ndarray, ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.
var Float64Array = require( '@stdlib/array-float64' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
var v = dnansumkbn2( [ x ] );
// returns 1.0The 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 bernoulli = require( '@stdlib/random-base-bernoulli' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var filledarrayBy = require( '@stdlib/array-filled-by' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var dnansumkbn2 = require( '@stdlib/blas-ext-base-ndarray-dnansumkbn2' );
function clbk() {
if ( bernoulli( 0.7 ) > 0 ) {
return discreteUniform( 0, 100 );
}
return NaN;
}
var xbuf = filledarrayBy( 10, 'float64', clbk );
var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );
var v = dnansumkbn2( [ x ] );
console.log( v );References
- Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." Computing 76 (3): 279–93. doi:10.1007/s00607-005-0139-x.
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.
