From f3921303d98fc7628dce7fd8bd78acb4296d5d3f Mon Sep 17 00:00:00 2001 From: kaustubh Date: Wed, 26 Nov 2025 11:28:53 +0530 Subject: [PATCH 1/8] feat : add --- .../stats/base/ndarray/smeankbn/README.md | 130 +++++++++++++ .../ndarray/smeankbn/benchmark/benchmark.js | 102 +++++++++++ .../docs/img/equation_arithmetic_mean.svg | 42 +++++ .../stats/base/ndarray/smeankbn/docs/repl.txt | 32 ++++ .../ndarray/smeankbn/docs/types/index.d.ts | 46 +++++ .../base/ndarray/smeankbn/docs/types/test.ts | 57 ++++++ .../base/ndarray/smeankbn/examples/index.js | 33 ++++ .../stats/base/ndarray/smeankbn/lib/index.js | 45 +++++ .../stats/base/ndarray/smeankbn/lib/main.js | 56 ++++++ .../stats/base/ndarray/smeankbn/package.json | 69 +++++++ .../stats/base/ndarray/smeankbn/test/test.js | 173 ++++++++++++++++++ 11 files changed, 785 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/img/equation_arithmetic_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md new file mode 100644 index 000000000000..72df0dd38b7a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md @@ -0,0 +1,130 @@ + + +# smeankbn + +> Calculate the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using an improved Kahan–Babuška algorithm. + +
+ +The [arithmetic mean][arithmetic-mean] is defined as + + + +```math +\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var smeankbn = require( '@stdlib/stats/base/ndarray/smeankbn' ); +``` + +#### smeankbn( arrays ) + +Calculates the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using an improved Kahan–Babuška algorithm. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = smeankbn( [ x ] ); +// returns 2.5 +``` + +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 `NaN`. +- The Kahan–Babuška algorithm is a variant of Kahan summation which provides improved numerical stability and accuracy compared to conventional summation, particularly when summing large numbers of floating-point values. + +
+ + + +
+ +## 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 smeankbn = require( '@stdlib/stats/base/ndarray/smeankbn' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = smeankbn( [ x ] ); +console.log( v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean + +
+ + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/benchmark/benchmark.js new file mode 100644 index 000000000000..d34b85acf0cc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/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 smeankbn = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// 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 = smeankbn( [ 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/stats/base/ndarray/smeankbn/docs/img/equation_arithmetic_mean.svg b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/img/equation_arithmetic_mean.svg new file mode 100644 index 000000000000..c31439606fb6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/img/equation_arithmetic_mean.svg @@ -0,0 +1,42 @@ + +mu equals StartFraction 1 Over n EndFraction sigma-summation Underscript i equals 0 Overscript n minus 1 Endscripts x Subscript i + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/repl.txt new file mode 100644 index 000000000000..ff2296fde386 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( arrays ) + Calculates the arithmetic mean of a one-dimensional single-precision + floating-point ndarray using an improved Kahan–Babuška algorithm. + + If provided an empty ndarray, the function returns `NaN`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: number + Arithmetic mean. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] ); + > var dt = 'float32'; + > 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 ] ) + ~0.3333 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/index.d.ts new file mode 100644 index 000000000000..87d71736b7d7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/index.d.ts @@ -0,0 +1,46 @@ +/* +* @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 { float32ndarray } from '@stdlib/types/ndarray'; + +/** +* Calculates the arithmetic mean of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. +* +* @param arrays - array-like object containing an input ndarray +* @returns arithmetic mean +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = smeankbn( [ x ] ); +* // returns 2.5 +*/ +declare function smeankbn( arrays: [ float32ndarray ] ): number; + + +// EXPORTS // + +export = smeankbn; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/docs/types/test.ts new file mode 100644 index 000000000000..a6b62aacb087 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/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 smeankbn = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + + smeankbn( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + smeankbn( '10' ); // $ExpectError + smeankbn( 10 ); // $ExpectError + smeankbn( true ); // $ExpectError + smeankbn( false ); // $ExpectError + smeankbn( null ); // $ExpectError + smeankbn( undefined ); // $ExpectError + smeankbn( [] ); // $ExpectError + smeankbn( {} ); // $ExpectError + smeankbn( ( 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': 'float32' + }); + + smeankbn(); // $ExpectError + smeankbn( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/examples/index.js new file mode 100644 index 000000000000..9a265d25c10f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/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 smeankbn = require( './../lib' ); + +var xbuf = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = smeankbn( [ x ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js new file mode 100644 index 000000000000..e54c05d2cde5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js @@ -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. +*/ + +'use strict'; + +/** +* Calculate the arithmetic mean of a single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. +* +* @module @stdlib/stats/base/ndarray/smeankbn +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var smeankbn = require( '@stdlib/stats/base/ndarray/smeankbn' ); +* +* var xbuf = new Float32Array( [ 1.0, -2.0, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var v = smeankbn( [ x ] ); +* // returns ~0.3333 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js new file mode 100644 index 000000000000..864b83028360 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js @@ -0,0 +1,56 @@ +/** +* @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/stats/strided/smeankbn' ).ndarray; + + +// MAIN // + +/** +* Calculates the arithmetic mean of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @returns {number} arithmetic mean +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = smeankbn( [ x ] ); +* // returns 2.5 +*/ +function smeankbn( 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 = smeankbn; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json new file mode 100644 index 000000000000..5d326914905f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/stats/base/ndarray/smeankbn", + "version": "0.0.0", + "description": "Calculate the arithmetic mean of a single-precision floating-point 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", + "average", + "avg", + "mean", + "arithmetic mean", + "central tendency", + "kbn", + "kahan", + "compensated", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js new file mode 100644 index 000000000000..90abc2ba8075 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js @@ -0,0 +1,173 @@ +/** +* @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 Float32Array = require( '@stdlib/array/float32' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var smeankbn = 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( 'float32', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof smeankbn, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( smeankbn.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the arithmetic mean of a one-dimensional ndarray', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + v = smeankbn( [ vector( x, 6, 1, 0 ) ] ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float32Array( [ -4.0, -5.0 ] ); + v = smeankbn( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = new Float32Array( [ -0.0, 0.0, -0.0 ] ); + v = smeankbn( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN ] ); + v = smeankbn( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + v = smeankbn( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty vector, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [] ); + + v = smeankbn( [ vector( x, 0, 1, 0 ) ] ); + t.strictEqual( isnan( 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 = new Float32Array( [ 1.0 ] ); + + v = smeankbn( [ 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 = new Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + + v = smeankbn( [ vector( x, 4, 2, 0 ) ] ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var x; + var v; + + x = new Float32Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + v = smeankbn( [ vector( x, 4, -2, 6 ) ] ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var x; + var v; + + x = new Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]); + + v = smeankbn( [ vector( x, 4, 2, 1 ) ] ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); From c60a85e1e69201ee59d1f0f16392fd7a18564ab4 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:38:59 -0800 Subject: [PATCH 2/8] docs: add missing reference Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/smeankbn/README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md index 72df0dd38b7a..ff82895198d2 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md @@ -79,7 +79,6 @@ The function has the following parameters: ## Notes - If provided an empty one-dimensional ndarray, the function returns `NaN`. -- The Kahan–Babuška algorithm is a variant of Kahan summation which provides improved numerical stability and accuracy compared to conventional summation, particularly when summing large numbers of floating-point values. @@ -111,6 +110,18 @@ 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]. + +
+ + +
@@ -125,6 +136,8 @@ console.log( v ); [arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean +[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106 +
From 6b18db0079faae84b6277f1d959ecd8c35de4869 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:42:46 -0800 Subject: [PATCH 3/8] docs: fix descriptions Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/smeankbn/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md index ff82895198d2..4c3a770ee048 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md @@ -20,7 +20,7 @@ limitations under the License. # smeankbn -> Calculate the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using an improved Kahan–Babuška algorithm. +> Compute the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.
@@ -53,7 +53,7 @@ var smeankbn = require( '@stdlib/stats/base/ndarray/smeankbn' ); #### smeankbn( arrays ) -Calculates the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array using an improved Kahan–Babuška algorithm. +Calculates the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. ```javascript var Float32Array = require( '@stdlib/array/float32' ); From 3c16b4b26d5dceec3abe9662e265ec15a9610310 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:43:24 -0800 Subject: [PATCH 4/8] docs: update desc Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md index 4c3a770ee048..b84657b388e1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/README.md @@ -53,7 +53,7 @@ var smeankbn = require( '@stdlib/stats/base/ndarray/smeankbn' ); #### smeankbn( arrays ) -Calculates the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. +Computes the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. ```javascript var Float32Array = require( '@stdlib/array/float32' ); From ef21f428f1cf68e9f0add7edc56431ab5f9441c2 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:44:22 -0800 Subject: [PATCH 5/8] docs: update desc Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/smeankbn/lib/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js index e54c05d2cde5..410d60e740e1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Calculate the arithmetic mean of a single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. +* Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. * * @module @stdlib/stats/base/ndarray/smeankbn * From ff50cb15d879504ee58cf3663aae565280c13c74 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:45:07 -0800 Subject: [PATCH 6/8] docs: update desc Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/smeankbn/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js index 864b83028360..a607c0c52f79 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/lib/main.js @@ -30,7 +30,7 @@ var strided = require( '@stdlib/stats/strided/smeankbn' ).ndarray; // MAIN // /** -* Calculates the arithmetic mean of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. +* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. * * @param {ArrayLikeObject} arrays - array-like object containing an input ndarray * @returns {number} arithmetic mean From 7aece51d15e418f6e3704a70332aa10f1eedc31e Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:45:42 -0800 Subject: [PATCH 7/8] docs: update desc Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/smeankbn/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json index 5d326914905f..5f3371f21a4a 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/stats/base/ndarray/smeankbn", "version": "0.0.0", - "description": "Calculate the arithmetic mean of a single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.", + "description": "Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From dbd102363740fe251aaf1bcc3011f12fbb01af1c Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 26 Nov 2025 00:46:42 -0800 Subject: [PATCH 8/8] test: update descriptions Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/smeankbn/test/test.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js index 90abc2ba8075..3586946cf690 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/smeankbn/test/test.js @@ -85,7 +85,7 @@ tape( 'the function calculates the arithmetic mean of a one-dimensional ndarray' t.end(); }); -tape( 'if provided an empty vector, the function returns `NaN`', function test( t ) { +tape( 'if provided an empty ndarray, the function returns `NaN`', function test( t ) { var x; var v; @@ -97,7 +97,7 @@ tape( 'if provided an empty vector, the function returns `NaN`', function test( 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;