gcusumkbn2

Compute the cumulative sum of a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.

Installation

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

Usage

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

gcusumkbn2( arrays )

Computes the cumulative sum of a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.

var ndarray2array = require( '@stdlib/ndarray-to-array' );
var scalar2ndarray = require( '@stdlib/ndarray-base-from-scalar' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );

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

var ybuf = [ 0.0, 0.0, 0.0, 0.0 ];
var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );

var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );

var v = gcusumkbn2( [ x, y, initial ] );
// returns <ndarray>

var bool = ( v === y );
// returns true

var arr = ndarray2array( v );
// returns [ 1.0, 4.0, 8.0, 10.0 ]

The function has the following parameters:

• arrays: array-like object containing a one-dimensional input ndarray, a one-dimensional output ndarray, and a zero-dimensional ndarray containing the initial sum.

Notes

• If provided an empty one-dimensional input ndarray, the function returns the output ndarray unchanged.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var zerosLike = require( '@stdlib/ndarray-zeros-like' );
var scalar2ndarray = require( '@stdlib/ndarray-from-scalar' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var gcusumkbn2 = require( '@stdlib/blas-ext-base-ndarray-gcusumkbn2' );

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 y = zerosLike( x );
console.log( ndarray2array( y ) );

var initial = scalar2ndarray( 100.0, {
    'dtype': 'generic'
});

var v = gcusumkbn2( [ x, y, initial ] );
console.log( ndarray2array( 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.