From b1e3366b77ab54a3ddfdae9b146a8abe0cd5df61 Mon Sep 17 00:00:00 2001
From: AtharvaPatange <164712914+AtharvaPatange@users.noreply.github.com>
Date: Sun, 1 Nov 2026 15:55:08 +0530
Subject: [PATCH] feat: add `blas/ext/base/ndarray/dapxsumkbn`
Ref: https://github.com/stdlib-js/stdlib/issues/14404
---
.../ext/base/ndarray/dapxsumkbn/README.md | 135 ++++++++++
.../ndarray/dapxsumkbn/benchmark/benchmark.js | 108 ++++++++
.../ext/base/ndarray/dapxsumkbn/docs/repl.txt | 32 +++
.../ndarray/dapxsumkbn/docs/types/index.d.ts | 56 +++++
.../ndarray/dapxsumkbn/docs/types/test.ts | 64 +++++
.../base/ndarray/dapxsumkbn/examples/index.js | 38 +++
.../ext/base/ndarray/dapxsumkbn/lib/index.js | 48 ++++
.../ext/base/ndarray/dapxsumkbn/lib/main.js | 71 ++++++
.../ext/base/ndarray/dapxsumkbn/package.json | 72 ++++++
.../ext/base/ndarray/dapxsumkbn/test/test.js | 235 ++++++++++++++++++
10 files changed, 859 insertions(+)
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/README.md
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/benchmark/benchmark.js
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/repl.txt
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/index.d.ts
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/test.ts
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/examples/index.js
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/index.js
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/main.js
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/package.json
create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/test/test.js
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/README.md
new file mode 100644
index 000000000000..8945595f34a8
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/README.md
@@ -0,0 +1,135 @@
+
+
+# dapxsumkbn
+
+> Add a scalar constant to each element in a one-dimensional double-precision floating-point ndarray and compute the sum using an improved Kahan–Babuška algorithm.
+
+
+
+
+
+
+
+
+
+## Usage
+
+```javascript
+var dapxsumkbn = require( '@stdlib/blas/ext/base/ndarray/dapxsumkbn' );
+```
+
+#### dapxsumkbn( arrays )
+
+Adds a scalar constant to each element in a one-dimensional double-precision floating-point ndarray and computes the sum using an improved Kahan–Babuška algorithm.
+
+```javascript
+var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+
+var x = new Float64Vector( [ 1.0, -2.0, 2.0 ] );
+
+var alpha = scalar2ndarray( 5.0, {
+ 'dtype': 'float64'
+});
+
+var v = dapxsumkbn( [ x, alpha ] );
+// returns 16.0
+```
+
+The function has the following parameters:
+
+- **arrays**: array-like object containing the following ndarrays:
+
+ - a one-dimensional input ndarray.
+ - a zero-dimensional ndarray containing the scalar constant to add.
+
+
+
+
+
+
+
+## Notes
+
+- If provided an empty one-dimensional ndarray, the function returns `0.0`.
+
+
+
+
+
+
+
+## Examples
+
+
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
+var dapxsumkbn = require( '@stdlib/blas/ext/base/ndarray/dapxsumkbn' );
+
+var opts = {
+ 'dtype': 'float64'
+};
+
+var x = discreteUniform( [ 10 ], -100, 100, opts );
+console.log( ndarray2array( x ) );
+
+var alpha = scalar2ndarray( 5.0, opts );
+console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) );
+
+var v = dapxsumkbn( [ x, alpha ] );
+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][@neumaier:1974a].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
+
+
+
+
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/benchmark/benchmark.js
new file mode 100644
index 000000000000..a9ca07e77892
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/benchmark/benchmark.js
@@ -0,0 +1,108 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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/uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var dapxsumkbn = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+ 'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - ndarray length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+ var alpha;
+ var x;
+
+ x = uniform( [ len ], -100.0, 100.0, options );
+ alpha = scalar2ndarray( 5.0, options );
+ return benchmark;
+
+ /**
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark( b ) {
+ var v;
+ var i;
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ v = dapxsumkbn( [ x, alpha ] );
+ if ( isnan( v ) ) {
+ b.fail( 'should not return NaN' );
+ }
+ }
+ b.toc();
+ if ( isnan( 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( format( '%s:len=%d', pkg, len ), f );
+ }
+}
+
+main();
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/repl.txt
new file mode 100644
index 000000000000..45c5cb7ff268
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/repl.txt
@@ -0,0 +1,32 @@
+
+{{alias}}( arrays )
+ Adds a scalar constant to each element in a one-dimensional double-precision
+ floating-point ndarray and computes the sum using an improved Kahan–Babuška
+ algorithm.
+
+ If provided an empty ndarray, the function returns `0.0`.
+
+ Parameters
+ ----------
+ arrays: ArrayLikeObject
+ Array-like object containing the following ndarrays:
+
+ - a one-dimensional input ndarray.
+ - a zero-dimensional ndarray containing the scalar constant to add.
+
+ Returns
+ -------
+ out: number
+ Sum.
+
+ Examples
+ --------
+ > var buf = [ 1.0, -2.0, 2.0 ];
+ > var x = new {{alias:@stdlib/ndarray/vector/float64}}( buf );
+ > var opts = { 'dtype': 'float64' };
+ > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 5.0, opts );
+ > {{alias}}( [ x, alpha ] )
+ 16.0
+
+ See Also
+ --------
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/index.d.ts
new file mode 100644
index 000000000000..b33c99f17c85
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/index.d.ts
@@ -0,0 +1,56 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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
+
+///
+
+import { float64ndarray, typedndarray } from '@stdlib/types/ndarray';
+
+/**
+* Adds a scalar constant to each element in a one-dimensional double-precision floating-point ndarray and computes the sum using an improved Kahan–Babuška algorithm.
+*
+* ## Notes
+*
+* - The function expects the following ndarrays:
+*
+* - a one-dimensional input ndarray.
+* - a zero-dimensional ndarray containing the scalar constant to add.
+*
+* @param arrays - array-like object containing ndarrays
+* @returns sum
+*
+* @example
+* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+*
+* var x = new Float64Vector( [ 1.0, -2.0, 2.0 ] );
+*
+* var alpha = scalar2ndarray( 5.0, {
+* 'dtype': 'float64'
+* });
+*
+* var v = dapxsumkbn( [ x, alpha ] );
+* // returns 16.0
+*/
+declare function dapxsumkbn( arrays: [ float64ndarray, typedndarray ] ): number;
+
+
+// EXPORTS //
+
+export = dapxsumkbn;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/test.ts
new file mode 100644
index 000000000000..3358504a8d79
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/docs/types/test.ts
@@ -0,0 +1,64 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+import dapxsumkbn = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+ const x = zeros( [ 10 ], {
+ 'dtype': 'float64'
+ });
+ const alpha = scalar2ndarray( 5.0, {
+ 'dtype': 'float64'
+ });
+
+ dapxsumkbn( [ x, alpha ] ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+ dapxsumkbn( '10' ); // $ExpectError
+ dapxsumkbn( 5 ); // $ExpectError
+ dapxsumkbn( true ); // $ExpectError
+ dapxsumkbn( false ); // $ExpectError
+ dapxsumkbn( null ); // $ExpectError
+ dapxsumkbn( undefined ); // $ExpectError
+ dapxsumkbn( [] ); // $ExpectError
+ dapxsumkbn( {} ); // $ExpectError
+ dapxsumkbn( ( 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': 'float64'
+ });
+ const alpha = scalar2ndarray( 5.0, {
+ 'dtype': 'float64'
+ });
+
+ dapxsumkbn(); // $ExpectError
+ dapxsumkbn( [ x, alpha ], {} ); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/examples/index.js
new file mode 100644
index 000000000000..72a870bd3921
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/examples/index.js
@@ -0,0 +1,38 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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';
+
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
+var dapxsumkbn = require( './../lib' );
+
+var opts = {
+ 'dtype': 'float64'
+};
+
+var x = discreteUniform( [ 10 ], -100, 100, opts );
+console.log( ndarray2array( x ) );
+
+var alpha = scalar2ndarray( 5.0, opts );
+console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) );
+
+var v = dapxsumkbn( [ x, alpha ] );
+console.log( v );
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/index.js
new file mode 100644
index 000000000000..90efa2479cfa
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/index.js
@@ -0,0 +1,48 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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';
+
+/**
+* Add a scalar constant to each element in a one-dimensional double-precision floating-point ndarray and compute the sum using an improved Kahan–Babuška algorithm.
+*
+* @module @stdlib/blas/ext/base/ndarray/dapxsumkbn
+*
+* @example
+* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+* var dapxsumkbn = require( '@stdlib/blas/ext/base/ndarray/dapxsumkbn' );
+*
+* var x = new Float64Vector( [ 1.0, -2.0, 2.0 ] );
+*
+* var alpha = scalar2ndarray( 5.0, {
+* 'dtype': 'float64'
+* });
+*
+* var v = dapxsumkbn( [ x, alpha ] );
+* // returns 16.0
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/main.js
new file mode 100644
index 000000000000..efc545a96e57
--- /dev/null
+++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dapxsumkbn/lib/main.js
@@ -0,0 +1,71 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 numelDimension = require( '@stdlib/ndarray/base/numel-dimension' );
+var getStride = require( '@stdlib/ndarray/base/stride' );
+var getOffset = require( '@stdlib/ndarray/base/offset' );
+var getData = require( '@stdlib/ndarray/base/data-buffer' );
+var strided = require( '@stdlib/blas/ext/base/dapxsumkbn' ).ndarray;
+var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
+
+
+// MAIN //
+
+/**
+* Adds a scalar constant to each element in a one-dimensional double-precision floating-point ndarray and computes the sum using an improved Kahan–Babuška algorithm.
+*
+* ## Notes
+*
+* - The function expects the following ndarrays:
+*
+* - a one-dimensional input ndarray.
+* - a zero-dimensional ndarray containing the scalar constant to add.
+*
+* @param {ArrayLikeObject