From a7bb0a912e1e19cdc3041742ef90a24a225c23a4 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Fri, 5 Dec 2025 23:21:03 +0530 Subject: [PATCH 1/5] feat: add blas/ext/base/ndarray/gsumkbn --- .../blas/ext/base/ndarray/gsumkbn/README.md | 123 +++++++++++++ .../ndarray/gsumkbn/benchmark/benchmark.js | 102 +++++++++++ .../ext/base/ndarray/gsumkbn/docs/repl.txt | 34 ++++ .../ndarray/gsumkbn/docs/types/index.d.ts | 45 +++++ .../base/ndarray/gsumkbn/docs/types/test.ts | 57 ++++++ .../base/ndarray/gsumkbn/examples/index.js | 33 ++++ .../ext/base/ndarray/gsumkbn/lib/index.js | 44 +++++ .../blas/ext/base/ndarray/gsumkbn/lib/main.js | 55 ++++++ .../ext/base/ndarray/gsumkbn/package.json | 69 +++++++ .../ext/base/ndarray/gsumkbn/test/test.js | 172 ++++++++++++++++++ 10 files changed, 734 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/README.md new file mode 100644 index 000000000000..df4066f7bee4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/README.md @@ -0,0 +1,123 @@ + + +# gsumkbn + +> Compute the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. + +
+ +
+ + + +
+ +## Usage + +```javascript +var gsumkbn = require( '@stdlib/blas/ext/base/ndarray/gsumkbn' ); +``` + +#### gsumkbn( arrays ) + +Computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. + +```javascript +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 v = gsumkbn( [ x ] ); +// returns 10.0 +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray. + +
+ + + +
+ +## Notes + +- If provided an empty real-valued one-dimensional ndarray, the function returns `0.0`. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var gsumkbn = require( '@stdlib/blas/ext/base/ndarray/gsumkbn' ); + +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 v = gsumkbn( [ x ] ); +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]. + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js new file mode 100644 index 000000000000..3646c45101c4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js @@ -0,0 +1,102 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var pkg = require( './../package.json' ).name; +var gsumkbn = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// 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, -10.0, 10.0, options ); + x = new ndarray( options.dtype, 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 = gsumkbn( [x] ); + 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( pkg + ':len=' + len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt new file mode 100644 index 000000000000..14d6d2f91292 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt @@ -0,0 +1,34 @@ + +{{alias}}( arrays ) + Computes the sum of all elements in a one-dimensional ndarray using an + improved Kahan–Babuška algorithm. + + If provided a real-valued empty ndarray, the function returns `0.0`. + + If provided a complex-valued empty ndarray, the function returns `0+0i`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: number|Complex + Sum. + + Examples + -------- + > var xbuf = [ 1.0, 2.0, 3.0 ]; + > var dt = 'generic'; + > var sh = [ xbuf.length ]; + > 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 ] ) + 6.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts new file mode 100644 index 000000000000..284a8f58981d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts @@ -0,0 +1,45 @@ +/* +* @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 + +/// + +import { typedndarray } from '@stdlib/types/ndarray'; + +/** +* Computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. +* +* @param arrays - array-like object containing an input ndarray +* @returns sum +* +* @example +* 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 v = gsumkbn( [ x ] ); +* // returns 10.0 +*/ +declare function gsumkbn = typedndarray>( arrays: [T] ): number; + + +// EXPORTS // + +export = gsumkbn; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts new file mode 100644 index 000000000000..b2b293526f8c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/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 gsumkbn = require( './index' ); + + +// TESTS // + +// The function returns a sum... +{ + const x = zeros( [10], { + 'dtype': 'float64' + }); + + gsumkbn( [x] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + gsumkbn( '10' ); // $ExpectError + gsumkbn( 10 ); // $ExpectError + gsumkbn( true ); // $ExpectError + gsumkbn( false ); // $ExpectError + gsumkbn( null ); // $ExpectError + gsumkbn( undefined ); // $ExpectError + gsumkbn( [] ); // $ExpectError + gsumkbn( {} ); // $ExpectError + gsumkbn( ( 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' + }); + + gsumkbn(); // $ExpectError + gsumkbn( [x], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js new file mode 100644 index 000000000000..fe7d31d5c554 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js @@ -0,0 +1,33 @@ +/** +* @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'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var gsumkbn = require( './../lib' ); + +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 v = gsumkbn( [x] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/index.js new file mode 100644 index 000000000000..f76baa008801 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/index.js @@ -0,0 +1,44 @@ +/** +* @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'; + +/** +* Compute the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. +* +* @module @stdlib/blas/ext/base/ndarray/gsumkbn +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var gsumkbn = require( '@stdlib/blas/ext/base/ndarray/gsumkbn' ); +* +* var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; +* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = gsumkbn( [ x ] ); +* // returns 10.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js new file mode 100644 index 000000000000..3cd6e2a63078 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js @@ -0,0 +1,55 @@ +/** +* @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 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/gsumkbn' ).ndarray; + + +// MAIN // + +/** +* Computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @returns {(number|ComplexLike)} sum +* +* @example +* 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 v = gsumkbn( [ x ] ); +* // returns 10.0 +*/ +function gsumkbn( arrays ) { + var x = arrays[0]; + return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = gsumkbn; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/package.json new file mode 100644 index 000000000000..a3986f61d5d4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/gsumkbn", + "version": "0.0.0", + "description": "Compute the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "blas", + "extended", + "sum", + "total", + "summation", + "compensated", + "kahan", + "kbn", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js new file mode 100644 index 000000000000..e21b1b643633 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js @@ -0,0 +1,172 @@ +/** +* @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 tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var gsumkbn = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'generic', buffer, [length], [stride], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof gsumkbn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( gsumkbn.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm', function test( t ) { + var x; + var v; + + x = [1.0, -2.0, -4.0, 5.0, 0.0, 3.0]; + v = gsumkbn( [vector( x, 6, 1, 0 )] ); + t.strictEqual( v, 3.0, 'returns expected value' ); + + x = [-4.0, -5.0]; + v = gsumkbn( [vector( x, 2, 1, 0 )] ); + t.strictEqual( v, -9.0, 'returns expected value' ); + + x = [-0.0, 0.0, -0.0]; + v = gsumkbn( [vector( x, 3, 1, 0 )] ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [NaN]; + v = gsumkbn( [vector( x, 1, 1, 0 )] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [NaN, NaN]; + v = gsumkbn( [vector( x, 2, 1, 0 )] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty real-valued vector, the function returns `0.0`', function test( t ) { + var x; + var v; + + x = []; + + v = gsumkbn( [vector( x, 0, 1, 0 )] ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a vector containing a single element, the function returns that element', function test( t ) { + var x; + var v; + + x = [1.0]; + + v = gsumkbn( [vector( x, 1, 1, 0 )] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + + v = gsumkbn( [vector( x, 4, 2, 0 )] ); + + t.strictEqual( v, 5.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = gsumkbn( [vector( x, 4, -2, 6 )] ); + + t.strictEqual( v, 5.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var x; + var v; + + x = [ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]; + + v = gsumkbn( [vector( x, 4, 2, 1 )] ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); From 917e79a0ccd0ba807294b6213de3e88f390ac724 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 7 Dec 2025 02:36:26 -0800 Subject: [PATCH 2/5] docs: update copy Signed-off-by: Athan --- .../@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt index 14d6d2f91292..c1eade96705b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/repl.txt @@ -3,9 +3,7 @@ Computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. - If provided a real-valued empty ndarray, the function returns `0.0`. - - If provided a complex-valued empty ndarray, the function returns `0+0i`. + If provided an empty ndarray, the function returns `0.0`. Parameters ---------- @@ -14,7 +12,7 @@ Returns ------- - out: number|Complex + out: number Sum. Examples From d6d5cc43cd796db5a937d0a7a00c537ffc525223 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 7 Dec 2025 02:38:39 -0800 Subject: [PATCH 3/5] docs: fix type Signed-off-by: Athan --- .../@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js index 3cd6e2a63078..a89ed5f1230b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js @@ -33,7 +33,7 @@ var strided = require( '@stdlib/blas/ext/base/gsumkbn' ).ndarray; * Computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm. * * @param {ArrayLikeObject} arrays - array-like object containing an input ndarray -* @returns {(number|ComplexLike)} sum +* @returns {number} sum * * @example * var ndarray = require( '@stdlib/ndarray/base/ctor' ); From 4f72a742e71416fcc3723d5f387f4c1d56de51e6 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 7 Dec 2025 02:44:30 -0800 Subject: [PATCH 4/5] style: fix spacing --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../ndarray/gsumkbn/benchmark/benchmark.js | 4 +-- .../ndarray/gsumkbn/docs/types/index.d.ts | 2 +- .../base/ndarray/gsumkbn/docs/types/test.ts | 6 ++-- .../base/ndarray/gsumkbn/examples/index.js | 4 +-- .../blas/ext/base/ndarray/gsumkbn/lib/main.js | 2 +- .../ext/base/ndarray/gsumkbn/test/test.js | 36 +++++++++---------- 6 files changed, 27 insertions(+), 27 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js index 3646c45101c4..dbc0b4b38cbc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/benchmark/benchmark.js @@ -50,7 +50,7 @@ function createBenchmark( len ) { var x; xbuf = uniform( len, -10.0, 10.0, options ); - x = new ndarray( options.dtype, xbuf, [len], [1], 0, 'row-major' ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); return benchmark; @@ -60,7 +60,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v = gsumkbn( [x] ); + v = gsumkbn( [ x ] ); if ( isnan( v ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts index 284a8f58981d..fadecc8034fd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/index.d.ts @@ -37,7 +37,7 @@ import { typedndarray } from '@stdlib/types/ndarray'; * var v = gsumkbn( [ x ] ); * // returns 10.0 */ -declare function gsumkbn = typedndarray>( arrays: [T] ): number; +declare function gsumkbn = typedndarray>( arrays: [ T ] ): number; // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts index b2b293526f8c..f3851f84ead9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/docs/types/test.ts @@ -30,7 +30,7 @@ import gsumkbn = require( './index' ); 'dtype': 'float64' }); - gsumkbn( [x] ); // $ExpectType number + gsumkbn( [ x ] ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... @@ -48,10 +48,10 @@ import gsumkbn = require( './index' ); // The compiler throws an error if the function is provided an unsupported number of arguments... { - const x = zeros( [10], { + const x = zeros( [ 10 ], { 'dtype': 'float64' }); gsumkbn(); // $ExpectError - gsumkbn( [x], {} ); // $ExpectError + gsumkbn( [ x ], {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js index fe7d31d5c554..b6d8c37e54ad 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/examples/index.js @@ -26,8 +26,8 @@ var gsumkbn = require( './../lib' ); var xbuf = discreteUniform( 10, -50, 50, { 'dtype': 'generic' }); -var x = new ndarray( 'generic', xbuf, [xbuf.length], [1], 0, 'row-major' ); +var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var v = gsumkbn( [x] ); +var v = gsumkbn( [ x ] ); console.log( v ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js index a89ed5f1230b..a8ed24934c06 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/lib/main.js @@ -45,7 +45,7 @@ var strided = require( '@stdlib/blas/ext/base/gsumkbn' ).ndarray; * // returns 10.0 */ function gsumkbn( arrays ) { - var x = arrays[0]; + var x = arrays[ 0 ]; return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len } diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js index e21b1b643633..20e9d7396804 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js @@ -40,7 +40,7 @@ var gsumkbn = require( './../lib' ); * @returns {ndarray} one-dimensional ndarray */ function vector( buffer, length, stride, offset ) { - return new ndarray( 'generic', buffer, [length], [stride], offset, 'row-major' ); + return new ndarray( 'generic', buffer, [ length ], [ stride ], offset, 'row-major' ); } @@ -57,28 +57,28 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function computes the sum of all elements in a one-dimensional ndarray using an improved Kahan–Babuška algorithm', function test( t ) { +tape( 'the function computes the sum of all elements in a one-dimensional ndarray', function test( t ) { var x; var v; - x = [1.0, -2.0, -4.0, 5.0, 0.0, 3.0]; - v = gsumkbn( [vector( x, 6, 1, 0 )] ); + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; + v = gsumkbn( [ vector( x, 6, 1, 0 ) ] ); t.strictEqual( v, 3.0, 'returns expected value' ); - x = [-4.0, -5.0]; - v = gsumkbn( [vector( x, 2, 1, 0 )] ); + x = [ -4.0, -5.0 ]; + v = gsumkbn( [ vector( x, 2, 1, 0 ) ] ); t.strictEqual( v, -9.0, 'returns expected value' ); - x = [-0.0, 0.0, -0.0]; - v = gsumkbn( [vector( x, 3, 1, 0 )] ); + x = [ -0.0, 0.0, -0.0 ]; + v = gsumkbn( [ vector( x, 3, 1, 0 ) ] ); t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); - x = [NaN]; - v = gsumkbn( [vector( x, 1, 1, 0 )] ); + x = [ NaN ]; + v = gsumkbn( [ vector( x, 1, 1, 0 ) ] ); t.strictEqual( isnan( v ), true, 'returns expected value' ); - x = [NaN, NaN]; - v = gsumkbn( [vector( x, 2, 1, 0 )] ); + x = [ NaN, NaN ]; + v = gsumkbn( [ vector( x, 2, 1, 0 ) ] ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); @@ -90,7 +90,7 @@ tape( 'if provided an empty real-valued vector, the function returns `0.0`', fun x = []; - v = gsumkbn( [vector( x, 0, 1, 0 )] ); + v = gsumkbn( [ vector( x, 0, 1, 0 ) ] ); t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); t.end(); @@ -100,9 +100,9 @@ tape( 'if provided a vector containing a single element, the function returns th var x; var v; - x = [1.0]; + x = [ 1.0 ]; - v = gsumkbn( [vector( x, 1, 1, 0 )] ); + v = gsumkbn( [ vector( x, 1, 1, 0 ) ] ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); @@ -123,7 +123,7 @@ tape( 'the function supports one-dimensional ndarrays having non-unit strides', 2.0 ]; - v = gsumkbn( [vector( x, 4, 2, 0 )] ); + v = gsumkbn( [ vector( x, 4, 2, 0 ) ] ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); @@ -144,7 +144,7 @@ tape( 'the function supports one-dimensional ndarrays having negative strides', 2.0 ]; - v = gsumkbn( [vector( x, 4, -2, 6 )] ); + v = gsumkbn( [ vector( x, 4, -2, 6 ) ] ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); @@ -165,7 +165,7 @@ tape( 'the function supports one-dimensional ndarrays having non-zero offsets', 4.0 // 3 ]; - v = gsumkbn( [vector( x, 4, 2, 1 )] ); + v = gsumkbn( [ vector( x, 4, 2, 1 ) ] ); t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); From f25686dd822f7ea17773ec440bad48ba91c67c1d Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 7 Dec 2025 02:45:33 -0800 Subject: [PATCH 5/5] test: update desc --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js index 20e9d7396804..0167111f5930 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsumkbn/test/test.js @@ -84,7 +84,7 @@ tape( 'the function computes the sum of all elements in a one-dimensional ndarra t.end(); }); -tape( 'if provided an empty real-valued vector, the function returns `0.0`', function test( t ) { +tape( 'if provided an empty ndarray, the function returns `0.0`', function test( t ) { var x; var v; @@ -96,7 +96,7 @@ tape( 'if provided an empty real-valued vector, the function returns `0.0`', fun t.end(); }); -tape( 'if provided a vector containing a single element, the function returns that element', function test( t ) { +tape( 'if provided an ndarray containing a single element, the function returns that element', function test( t ) { var x; var v;