From 28544effc39eae8a7ce6f8f58e2f599bc5884997 Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Mon, 1 Dec 2025 17:34:42 +0530 Subject: [PATCH 1/6] feat: add stats/base/ndarray/sdsnanmeanors --- .../base/ndarray/sdsnanmeanors/README.md | 138 ++++++++++++ .../sdsnanmeanors/benchmark/benchmark.js | 109 ++++++++++ .../docs/img/equation_arithmetic_mean.svg | 42 ++++ .../base/ndarray/sdsnanmeanors/docs/repl.txt | 38 ++++ .../sdsnanmeanors/docs/types/index.d.ts | 46 ++++ .../ndarray/sdsnanmeanors/docs/types/test.ts | 57 +++++ .../ndarray/sdsnanmeanors/examples/index.js | 40 ++++ .../base/ndarray/sdsnanmeanors/lib/index.js | 45 ++++ .../base/ndarray/sdsnanmeanors/lib/main.js | 56 +++++ .../base/ndarray/sdsnanmeanors/package.json | 70 ++++++ .../base/ndarray/sdsnanmeanors/test/test.js | 200 ++++++++++++++++++ 11 files changed, 841 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/img/equation_arithmetic_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md new file mode 100644 index 000000000000..5b1608d5b137 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md @@ -0,0 +1,138 @@ + + +# sdsnanmeanors + +> Compute the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray, ignoring NaN values and 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 sdsnanmeanors = require( '@stdlib/stats/base/ndarray/sdsnanmeanors' ); +``` + +#### sdsnanmeanors( arrays ) + +Computes the [arithmetic mean][arithmetic-mean] of a one-dimensional single-precision floating-point ndarray, ignoring NaN values and 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, -2.0, NaN, 2.0 ] ); +var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = sdsnanmeanors( [ x ] ); +// returns ~0.3333 +``` + +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`. +- If every indexed element is `NaN`, the function returns `NaN`. +- Accumulated intermediate values are stored as double-precision floating-point numbers. + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var sdsnanmeanors = require( '@stdlib/stats/base/ndarray/sdsnanmeanors' ); + +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + +var xbuf = filledarrayBy( 10, 'float32', rand ); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = sdsnanmeanors( [ x ] ); +console.log( v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean + +
+ + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/benchmark/benchmark.js new file mode 100644 index 000000000000..508aa1bdd57b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/benchmark/benchmark.js @@ -0,0 +1,109 @@ +/** +* @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 bernoulli = require( '@stdlib/random/base/bernoulli' ); +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 sdsnanmeanors = 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; + var i; + + xbuf = uniform( len, -10.0, 10.0, options ); + for ( i = 0; i < len; i++ ) { + if ( bernoulli( 0.8 ) < 1 ) { + xbuf[ i ] = NaN; + } + } + 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 = sdsnanmeanors( [ 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/sdsnanmeanors/docs/img/equation_arithmetic_mean.svg b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/img/equation_arithmetic_mean.svg new file mode 100644 index 000000000000..c31439606fb6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/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/sdsnanmeanors/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt new file mode 100644 index 000000000000..53e3265fe26d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt @@ -0,0 +1,38 @@ + +{{alias}}( arrays ) + Computes the arithmetic mean of a one-dimensional single-precision + floating-point ndarray, ignoring NaN values and 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`. + + If every indexed element is `NaN`, 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, NaN, 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/sdsnanmeanors/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/types/index.d.ts new file mode 100644 index 000000000000..24894c14224a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/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 one-dimensional single-precision floating-point ndarray, ignoring NaN values and 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, -2.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = sdsnanmeanors( [ x ] ); +* // returns ~0.3333 +*/ +declare function sdsnanmeanors( arrays: [ float32ndarray ] ): number; + + +// EXPORTS // + +export = sdsnanmeanors; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/types/test.ts new file mode 100644 index 000000000000..b81153a8475c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/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 sdsnanmeanors = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + + sdsnanmeanors( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + sdsnanmeanors( '10' ); // $ExpectError + sdsnanmeanors( 10 ); // $ExpectError + sdsnanmeanors( true ); // $ExpectError + sdsnanmeanors( false ); // $ExpectError + sdsnanmeanors( null ); // $ExpectError + sdsnanmeanors( undefined ); // $ExpectError + sdsnanmeanors( [] ); // $ExpectError + sdsnanmeanors( {} ); // $ExpectError + sdsnanmeanors( ( 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' + }); + + sdsnanmeanors(); // $ExpectError + sdsnanmeanors( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/examples/index.js new file mode 100644 index 000000000000..b2e0283038f6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/examples/index.js @@ -0,0 +1,40 @@ +/** +* @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 uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var sdsnanmeanors = require( './../lib' ); + +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + +var xbuf = filledarrayBy( 10, 'float32', rand ); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = sdsnanmeanors( [ x ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/lib/index.js new file mode 100644 index 000000000000..8b2cc00f1781 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/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 one-dimensional single-precision floating-point ndarray, ignoring NaN values and using ordinary recursive summation with extended accumulation. +* +* @module @stdlib/stats/base/ndarray/sdsnanmeanors +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var sdsnanmeanors = require( '@stdlib/stats/base/ndarray/sdsnanmeanors' ); +* +* var xbuf = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = sdsnanmeanors( [ x ] ); +* // returns ~0.3333 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/lib/main.js new file mode 100644 index 000000000000..d323e1717a3c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/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/sdsnanmeanors' ).ndarray; + + +// MAIN // + +/** +* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray, ignoring NaN values and 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, -2.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = sdsnanmeanors( [ x ] ); +* // returns ~0.3333 +*/ +function sdsnanmeanors( 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 = sdsnanmeanors; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/package.json new file mode 100644 index 000000000000..8c3f90cddc46 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/stats/base/ndarray/sdsnanmeanors", + "version": "0.0.0", + "description": "Compute the arithmetic mean of a one-dimensional single-precision floating-point ndarray, ignoring NaN values and 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", + "nan", + "float32", + "single-precision", + "extended accumulation", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js new file mode 100644 index 000000000000..63fac4f4d9a1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js @@ -0,0 +1,200 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var sdsnanmeanors = 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 sdsnanmeanors, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( sdsnanmeanors.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 = sdsnanmeanors( [ vector( x, 6, 1, 0 ) ] ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = new Float32Array( [ -4.0, -5.0 ] ); + v = sdsnanmeanors( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); + v = sdsnanmeanors( [ vector( x, 4, 1, 0 ) ] ); + t.ok( v >= 0.333 && v <= 0.334, '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 = sdsnanmeanors( [ vector( x, 0, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if every indexed element is `NaN`, the function returns `NaN`', function test( t ) { + var x; + var v; + + x = new Float32Array( [ NaN ] ); + v = sdsnanmeanors( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + v = sdsnanmeanors( [ vector( x, 2, 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 = sdsnanmeanors( [ 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 = sdsnanmeanors( [ 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 = sdsnanmeanors( [ 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 = sdsnanmeanors( [ vector( x, 4, 2, 1 ) ] ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function ignores NaN values in non-unit stride arrays', function test( t ) { + var x; + var v; + + x = new Float32Array([ + 1.0, // 0 + NaN, + 2.0, // 1 + NaN, + -2.0, // 2 + NaN, + 4.0, // 3 + NaN + ]); + + v = sdsnanmeanors( [ vector( x, 4, 2, 0 ) ] ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); From 6c708ccb3b58c07cda6ca2b470e3ce2c5f289004 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:07:42 -0800 Subject: [PATCH 2/6] docs: update copy Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsnanmeanors/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md index 5b1608d5b137..892605f105ba 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/README.md @@ -79,7 +79,7 @@ The function has the following parameters: ## Notes - If provided an empty one-dimensional ndarray, the function returns `NaN`. -- If every indexed element is `NaN`, the function returns `NaN`. +- If every element is `NaN`, the function returns `NaN`. - Accumulated intermediate values are stored as double-precision floating-point numbers. From 87ea6fe0cb99afd2c6659f3a1437f7cd160413c4 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:08:59 -0800 Subject: [PATCH 3/6] docs: update copy Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt index 53e3265fe26d..13e0f2725162 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/docs/repl.txt @@ -9,7 +9,7 @@ If provided an empty ndarray, the function returns `NaN`. - If every indexed element is `NaN`, the function returns `NaN`. + If every element is `NaN`, the function returns `NaN`. Parameters ---------- From 799f63221fc0c7bb9034b9b1adc54fa0f77729e9 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:11:31 -0800 Subject: [PATCH 4/6] test: use strict equality test Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js index 63fac4f4d9a1..c27e36a3dcb1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js @@ -69,9 +69,9 @@ tape( 'the function calculates the arithmetic mean of a one-dimensional ndarray' v = sdsnanmeanors( [ vector( x, 2, 1, 0 ) ] ); t.strictEqual( v, -4.5, 'returns expected value' ); - x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); + x = new Float32Array( [ 1.0, -2.0, NaN, 4.0 ] ); v = sdsnanmeanors( [ vector( x, 4, 1, 0 ) ] ); - t.ok( v >= 0.333 && v <= 0.334, 'returns expected value' ); + t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); }); From 8348f46de4276a2a490b6406fa5705692843f1ee Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:12:50 -0800 Subject: [PATCH 5/6] test: update description Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js index c27e36a3dcb1..ec11a62d3f4c 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js @@ -88,7 +88,7 @@ tape( 'if provided an empty ndarray, the function returns `NaN`', function test( t.end(); }); -tape( 'if every indexed element is `NaN`, the function returns `NaN`', function test( t ) { +tape( 'if every element is `NaN`, the function returns `NaN`', function test( t ) { var x; var v; From 06ef62826e381e59494713a1ea716ed7ad749f14 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 2 Dec 2025 00:13:48 -0800 Subject: [PATCH 6/6] test: consolidate tests Signed-off-by: Athan --- .../base/ndarray/sdsnanmeanors/test/test.js | 29 +++---------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js index ec11a62d3f4c..64e57026108f 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/sdsnanmeanors/test/test.js @@ -121,13 +121,13 @@ tape( 'the function supports one-dimensional ndarrays having non-unit strides', x = new Float32Array([ 1.0, // 0 - 2.0, + NaN, 2.0, // 1 - -7.0, + NaN, -2.0, // 2 - 3.0, + NaN, 4.0, // 3 - 2.0 + NaN ]); v = sdsnanmeanors( [ vector( x, 4, 2, 0 ) ] ); @@ -177,24 +177,3 @@ tape( 'the function supports one-dimensional ndarrays having non-zero offsets', t.end(); }); - -tape( 'the function ignores NaN values in non-unit stride arrays', function test( t ) { - var x; - var v; - - x = new Float32Array([ - 1.0, // 0 - NaN, - 2.0, // 1 - NaN, - -2.0, // 2 - NaN, - 4.0, // 3 - NaN - ]); - - v = sdsnanmeanors( [ vector( x, 4, 2, 0 ) ] ); - - t.strictEqual( v, 1.25, 'returns expected value' ); - t.end(); -});