feat: add blas/ext/base/ndarray/csumkbn

lib/node_modules/@stdlib/blas/ext/base/ndarray/csumkbn/README.md

@@ -0,0 +1,127 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# csumkbn
+
+> Compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+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.
+
+```javascript
+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.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty one-dimensional ndarray, the function returns `0.0 + 0.0i`.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+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 );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<section class="references">
+
+## 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][@neumaier:1974a].
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/ndarray/csumkbn/benchmark/benchmark.js

@@ -0,0 +1,107 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var realf = require( '@stdlib/complex/float32/real' );
+var imagf = require( '@stdlib/complex/float32/imag' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var Complex64Array = require( '@stdlib/array/complex64' );
+var pkg = require( './../package.json' ).name;
+var csumkbn = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'complex64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var xbuf;
+	var x;
+
+	xbuf = uniform( len*2, -10.0, 10.0, {
+		'dtype': 'float32'
+	});
+	x = new ndarray( options.dtype, new Complex64Array( xbuf ), [ len ], [ 1 ], 0, 'row-major' );
+
+	return benchmark;
+
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = csumkbn( [ x ] );
+			if ( isnanf( realf( v ) ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnanf( imagf( v ) ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/base/ndarray/csumkbn/docs/repl.txt

@@ -0,0 +1,32 @@
+
+{{alias}}( arrays )
+    Computes the sum of all elements in a one-dimensional single-precision
+    complex floating-point ndarray using an improved Kahan–Babuška algorithm.
+
+    If provided an empty ndarray, the function returns `0.0`.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a one-dimensional input ndarray.
+
+    Returns
+    -------
+    out: Complex64
+        Sum.
+
+    Examples
+    --------
+    > var xbuf = new {{alias:@stdlib/array/complex64}}( [ 1.0, -2.0, 2.0, 3.0 ] );
+    > var dt = 'complex64';
+    > var sh = [ 2 ];
+    > var sx = [ 1 ];
+    > var ox = 0;
+    > var ord = 'row-major';
+    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+    > {{alias}}( [ x ] )
+    <Complex64>[ 3.0, 1.0 ]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/blas/ext/base/ndarray/csumkbn/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { complex64ndarray } from '@stdlib/types/ndarray';
+import { Complex64 } from '@stdlib/types/complex';
+
+/**
+* Computes the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.
+*
+* @param arrays - array-like object containing an input ndarray
+* @returns sum
+*
+* @example
+* 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 ]
+*/
+declare function csumkbn( arrays: [ complex64ndarray ] ): Complex64;
+
+
+// EXPORTS //
+
+export = csumkbn;

lib/node_modules/@stdlib/blas/ext/base/ndarray/csumkbn/docs/types/test.ts

@@ -0,0 +1,57 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import csumkbn = require( './index' );
+
+
+// TESTS //
+
+// The function returns a complex number...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'complex64'
+	});
+
+	csumkbn( [ x ] ); // $ExpectType Complex64
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+	csumkbn( '10' ); // $ExpectError
+	csumkbn( 10 ); // $ExpectError
+	csumkbn( true ); // $ExpectError
+	csumkbn( false ); // $ExpectError
+	csumkbn( null ); // $ExpectError
+	csumkbn( undefined ); // $ExpectError
+	csumkbn( [] ); // $ExpectError
+	csumkbn( {} ); // $ExpectError
+	csumkbn( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'complex64'
+	});
+
+	csumkbn(); // $ExpectError
+	csumkbn( [ x ], {} ); // $ExpectError
+}