From ece0defcfefb60b7b36750b7586d007cf7e1fa91 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Mon, 1 Dec 2025 00:29:46 +0530 Subject: [PATCH 1/4] feat: add stats/base/ndarray/sdsmeanors --- .../stats/base/ndarray/sdsmeanors/README.md | 131 +++++++++++++ .../ndarray/sdsmeanors/benchmark/benchmark.js | 102 +++++++++++ .../docs/img/equation_arithmetic_mean.svg | 42 +++++ .../base/ndarray/sdsmeanors/docs/repl.txt | 35 ++++ .../ndarray/sdsmeanors/docs/types/index.d.ts | 46 +++++ .../ndarray/sdsmeanors/docs/types/test.ts | 57 ++++++ .../base/ndarray/sdsmeanors/examples/index.js | 33 ++++ .../base/ndarray/sdsmeanors/lib/index.js | 45 +++++ .../stats/base/ndarray/sdsmeanors/lib/main.js | 56 ++++++ .../base/ndarray/sdsmeanors/package.json | 70 +++++++ .../base/ndarray/sdsmeanors/test/test.js | 173 ++++++++++++++++++ 11 files changed, 790 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/img/equation_arithmetic_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md new file mode 100644 index 000000000000..4e1bda21bebc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md @@ -0,0 +1,131 @@ + + +# sdsmeanors + +> Compute the [arithmetic mean][arithmetic-mean] of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. + +
+ +The [arithmetic mean][arithmetic-mean] is defined as + + + +```math +\mu = \frac{1}{n} \sum_{i=0}^{n-1} x_i +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var sdsmeanors = require( '@stdlib/stats/base/ndarray/sdsmeanors' ); +``` + +#### sdsmeanors( arrays ) + +Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. + +```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 = sdsmeanors( [ 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`. +- Accumulated intermediate values are stored as double-precision floating-point numbers. +- Ordinary recursive summation (i.e., "simple" summation) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute the arithmetic mean is acceptable; in all other cases, exercise due caution. + +
+ + + +
+ +## 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 sdsmeanors = require( '@stdlib/stats/base/ndarray/sdsmeanors' ); + +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 = sdsmeanors( [ x ] ); +console.log( v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean + +
+ + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/benchmark/benchmark.js new file mode 100644 index 000000000000..f3805fc20bc1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var pkg = require( './../package.json' ).name; +var sdsmeanors = 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 = sdsmeanors( [ x ] ); + if ( isnanf( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( 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/sdsmeanors/docs/img/equation_arithmetic_mean.svg b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/img/equation_arithmetic_mean.svg new file mode 100644 index 000000000000..c31439606fb6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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/sdsmeanors/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt new file mode 100644 index 000000000000..09e338ddae6a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt @@ -0,0 +1,35 @@ + +{{alias}}( arrays ) + Computes the arithmetic mean of a single-precision floating-point ndarray + using ordinary recursive summation with extended accumulation. + + Accumulated intermediate values are stored as double-precision floating- + point numbers. + + 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/sdsmeanors/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/index.d.ts new file mode 100644 index 000000000000..890e3f26887e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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'; + +/** +* Computes the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +* +* @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 = sdsmeanors( [ x ] ); +* // returns 2.5 +*/ +declare function sdsmeanors( arrays: [ float32ndarray ] ): number; + + +// EXPORTS // + +export = sdsmeanors; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/test.ts new file mode 100644 index 000000000000..41d6b5f4f5f8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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 sdsmeanors = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + + sdsmeanors( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + sdsmeanors( '10' ); // $ExpectError + sdsmeanors( 10 ); // $ExpectError + sdsmeanors( true ); // $ExpectError + sdsmeanors( false ); // $ExpectError + sdsmeanors( null ); // $ExpectError + sdsmeanors( undefined ); // $ExpectError + sdsmeanors( [] ); // $ExpectError + sdsmeanors( {} ); // $ExpectError + sdsmeanors( ( 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' + }); + + sdsmeanors(); // $ExpectError + sdsmeanors( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/examples/index.js new file mode 100644 index 000000000000..99fa1917ecd2 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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 sdsmeanors = 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 = sdsmeanors( [ x ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js new file mode 100644 index 000000000000..03f4c04bfef8 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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'; + +/** +* Compute the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +* +* @module @stdlib/stats/base/ndarray/sdsmeanors +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var sdsmeanors = require( '@stdlib/stats/base/ndarray/sdsmeanors' ); +* +* 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 = sdsmeanors( [ x ] ); +* // returns 2.5 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/main.js new file mode 100644 index 000000000000..dae785ba0bfc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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/sdsmeanors' ).ndarray; + + +// MAIN // + +/** +* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +* +* @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 = sdsmeanors( [ x ] ); +* // returns 2.5 +*/ +function sdsmeanors( 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 = sdsmeanors; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json new file mode 100644 index 000000000000..030c0d135361 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/stats/base/ndarray/sdsmeanors", + "version": "0.0.0", + "description": "Compute the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.", + "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", + "ors", + "float32", + "single-precision", + "extended accumulation", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js new file mode 100644 index 000000000000..c39841f6a91f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/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 Float32Array = require( '@stdlib/array/float32' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var sdsmeanors = 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 sdsmeanors, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( sdsmeanors.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 = sdsmeanors( [ vector( x, 6, 1, 0 ) ] ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float32Array( [ -4.0, -5.0 ] ); + v = sdsmeanors( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = new Float32Array( [ -0.0, 0.0, -0.0 ] ); + v = sdsmeanors( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN ] ); + v = sdsmeanors( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + v = sdsmeanors( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty ndarray, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [] ); + + v = sdsmeanors( [ vector( x, 0, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an ndarray containing a single element, the function returns that element', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0 ] ); + + v = sdsmeanors( [ 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 = sdsmeanors( [ 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 = sdsmeanors( [ 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 = sdsmeanors( [ vector( x, 4, 2, 1 ) ] ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); From fde222fea3e9b397ef18ab6a768c9de6f7a8a56f Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:19:29 -0800 Subject: [PATCH 2/4] test: use single-precision utils Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsmeanors/test/test.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js index c39841f6a91f..bfd92372eb81 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/test/test.js @@ -23,7 +23,7 @@ var tape = require( 'tape' ); var Float32Array = require( '@stdlib/array/float32' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); -var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var sdsmeanors = require( './../lib' ); @@ -72,7 +72,7 @@ tape( 'the function calculates the arithmetic mean of a one-dimensional ndarray' x = new Float32Array( [ -0.0, 0.0, -0.0 ] ); v = sdsmeanors( [ vector( x, 3, 1, 0 ) ] ); - t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); x = new Float32Array( [ NaN ] ); v = sdsmeanors( [ vector( x, 1, 1, 0 ) ] ); From 2ed81a14af9d6992a3dbfc58930c1afd3c96efc8 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:22:55 -0800 Subject: [PATCH 3/4] Apply suggestions from code review Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsmeanors/README.md | 5 ++--- .../stats/base/ndarray/sdsmeanors/docs/types/index.d.ts | 2 +- .../@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js | 2 +- .../@stdlib/stats/base/ndarray/sdsmeanors/package.json | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md index 4e1bda21bebc..55c23e9c8c60 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/README.md @@ -20,7 +20,7 @@ limitations under the License. # sdsmeanors -> Compute the [arithmetic mean][arithmetic-mean] of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +> Compute the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.
@@ -53,7 +53,7 @@ var sdsmeanors = require( '@stdlib/stats/base/ndarray/sdsmeanors' ); #### sdsmeanors( arrays ) -Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +Computes the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -80,7 +80,6 @@ The function has the following parameters: - If provided an empty one-dimensional ndarray, the function returns `NaN`. - Accumulated intermediate values are stored as double-precision floating-point numbers. -- Ordinary recursive summation (i.e., "simple" summation) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute the arithmetic mean is acceptable; in all other cases, exercise due caution.
diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/index.d.ts index 890e3f26887e..f289ff0fe26c 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { float32ndarray } from '@stdlib/types/ndarray'; /** -* Computes the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. * * @param arrays - array-like object containing an input ndarray * @returns arithmetic mean diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js index 03f4c04bfef8..7274d1749d6e 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. +* Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation. * * @module @stdlib/stats/base/ndarray/sdsmeanors * diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json index 030c0d135361..b4b8d210b020 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/stats/base/ndarray/sdsmeanors", "version": "0.0.0", - "description": "Compute the arithmetic mean of a single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.", + "description": "Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation with extended accumulation.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From a6ea46a3f2a4b4b49458a7f78b774dca679b14e0 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:24:05 -0800 Subject: [PATCH 4/4] docs: update description Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt index 09e338ddae6a..0b9df6d4e1e2 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsmeanors/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( arrays ) - Computes the arithmetic mean of a single-precision floating-point ndarray - using ordinary recursive summation with extended accumulation. + Computes the arithmetic mean of a one-dimensional single-precision floating- + point ndarray using ordinary recursive summation with extended accumulation. Accumulated intermediate values are stored as double-precision floating- point numbers.