README.md

csumkbn

Compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.

Usage

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

csumkbn( arrays )

Computes the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.

var Complex64Array = require( '@stdlib/array/complex64' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );

var xbuf = new Complex64Array( [ 1.0, -2.0, 2.0, 3.0 ] );
var x = new ndarray( 'complex64', xbuf, [ 2 ], [ 1 ], 0, 'row-major' );

var v = csumkbn( [ x ] );
// returns <Complex64>[ 3.0, 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 + 0.0i.

Examples

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

var xbuf = discreteUniform( 10, -50, 50, {
    'dtype': 'float32'
});
xbuf = new Complex64Array( xbuf );

var x = new ndarray( 'complex64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

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