From 9c80e53c56affb1c86f3a0a30c8469f0df18fda7 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 9 Jan 2026 19:00:34 +0000 Subject: [PATCH 01/14] feat: add stats/base/ndarray/snanstdev --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/README.md | 122 ++++++++++++++ .../ndarray/snanstdev/benchmark/benchmark.js | 112 ++++++++++++ .../docs/img/equation_arithmetic_mean.svg | 42 +++++ .../base/ndarray/snanstdev/docs/repl.txt | 32 ++++ .../ndarray/snanstdev/docs/types/index.d.ts | 46 +++++ .../base/ndarray/snanstdev/docs/types/test.ts | 57 +++++++ .../base/ndarray/snanstdev/examples/index.js | 41 +++++ .../stats/base/ndarray/snanstdev/lib/index.js | 45 +++++ .../stats/base/ndarray/snanstdev/lib/main.js | 56 ++++++ .../stats/base/ndarray/snanstdev/package.json | 63 +++++++ .../stats/base/ndarray/snanstdev/test/test.js | 159 ++++++++++++++++++ 11 files changed, 775 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/img/equation_arithmetic_mean.svg create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md new file mode 100644 index 000000000000..0ac1748cd75f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md @@ -0,0 +1,122 @@ + + +# snanstdev + +> Compute the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. + +
+ +This package provides an ndarray interface for computing the standard deviation of a one-dimensional +single-precision floating-point ndarray while ignoring `NaN` values. + +
+ + + +
+ +## Usage + +```javascript +var snanstdev = require( '@stdlib/stats/base/ndarray/snanstdev' ); +``` + +#### snanstdev( arrays ) + +Computes the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring NaN values. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); +var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = snanstdev( [ x ] ); +// returns +``` + +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`. + +
+ + + +
+ +## 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 snanstdev = require( '@stdlib/stats/base/ndarray/snanstdev' ); + +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 = snanstdev( [ x ] ); +console.log( v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js new file mode 100644 index 000000000000..5c085a3b33f3 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -0,0 +1,112 @@ +/** +* @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/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var snanstdev = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a random number. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var x; + + xbuf = filledarrayBy( len, 'float32', rand ); + x = new ndarray( 'float32', 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 = snanstdev( [ 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/img/equation_arithmetic_mean.svg b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/img/equation_arithmetic_mean.svg new file mode 100644 index 000000000000..c31439606fb6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/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/snanstdev/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt new file mode 100644 index 000000000000..0b21379350fc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( arrays ) + Computes the standard deviation of a one-dimensional single-precision + floating-point ndarray, ignoring `NaN` values. + + If provided an empty ndarray, the function returns `NaN`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: number + Computed standard deviation. + + 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 ] ) + NaN + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts new file mode 100644 index 000000000000..166728f0370a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/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 standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. +* +* @param arrays - array-like object containing an input ndarray +* @returns computed standard deviation +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = snanstdev( [ x ] ); +* // returns +*/ +declare function snanstdev( arrays: [ float32ndarray ] ): number; + + +// EXPORTS // + +export = snanstdev; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts new file mode 100644 index 000000000000..4b6b9261416f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/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 snanstdev = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + + snanstdev( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + snanstdev( '10' ); // $ExpectError + snanstdev( 10 ); // $ExpectError + snanstdev( true ); // $ExpectError + snanstdev( false ); // $ExpectError + snanstdev( null ); // $ExpectError + snanstdev( undefined ); // $ExpectError + snanstdev( [] ); // $ExpectError + snanstdev( {} ); // $ExpectError + snanstdev( ( 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' + }); + + snanstdev(); // $ExpectError + snanstdev( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js new file mode 100644 index 000000000000..3b4b39caa621 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js @@ -0,0 +1,41 @@ +/** +* @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 snanstdev = 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 = snanstdev( [ x ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js new file mode 100644 index 000000000000..dd49899527e5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/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 standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. +* +* @module @stdlib/stats/base/ndarray/snanstdev +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var snanstdev = require( '@stdlib/stats/base/ndarray/snanstdev' ); +* +* var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = snanstdev( [ x ] ); +* // returns +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js new file mode 100644 index 000000000000..e54cfe7c997d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/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/base/snanstdevpn' ).ndarray; + + +// MAIN // + +/** +* Computes the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @returns {number} standard deviation +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = snanstdev( [ x ] ); +* // returns NaN +*/ +function snanstdev( 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 = snanstdev; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/package.json new file mode 100644 index 000000000000..40a47a081410 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/package.json @@ -0,0 +1,63 @@ +{ + "name": "@stdlib/stats/base/ndarray/snanstdev", + "version": "0.0.0", + "description": "Compute the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values.", + "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", + "standard deviation", + "dispersion", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js new file mode 100644 index 000000000000..8e61d62f3539 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -0,0 +1,159 @@ +/** +* @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 snanstdev = 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 snanstdev, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( snanstdev.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the standard deviation of a one-dimensional ndarray, ignoring NaN values', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); + v = snanstdev( [ vector( x, 7, 1, 0 ) ] ); + t.strictEqual( v > 0.0, true, 'returns expected value' ); + + x = new Float32Array( [ -4.0, NaN, -5.0 ] ); + v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); + t.strictEqual( v > 0.0, true, 'returns expected value' ); + + x = new Float32Array( [ NaN ] ); + v = snanstdev( [ vector( x, 1, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + v = snanstdev( [ 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 = snanstdev( [ vector( x, 0, 1, 0 ) ] ); + + t.strictEqual( isnanf( v ), true, '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, + NaN, // 4 + NaN + ]); + + v = snanstdev( [ vector( x, 5, 2, 0 ) ] ); + t.strictEqual( v > 0.0, true, '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([ + NaN, // 4 + NaN, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + + v = snanstdev( [ vector( x, 5, -2, 8 ) ] ); + t.strictEqual( v > 0.0, true, '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 + 6.0, + NaN, // 4 + NaN + ]); + + v = snanstdev( [ vector( x, 5, 2, 1 ) ] ); + t.strictEqual( v > 0.0, true, 'returns expected value' ); + t.end(); +}); From c29e39101279810d8c21059ee5c2ff2c34bbedd8 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 9 Jan 2026 19:05:49 +0000 Subject: [PATCH 02/14] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/examples/index.js | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/lib/index.js | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/lib/main.js | 2 +- .../@stdlib/stats/base/ndarray/snanstdev/test/test.js | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md index 0ac1748cd75f..f2b43063fe53 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2025 The Stdlib Authors. +Copyright (c) 2026 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js index 5c085a3b33f3..90dbad9b3d38 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts index 166728f0370a..f76b44c9a32d 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts index 4b6b9261416f..970695353cd5 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts @@ -1,7 +1,7 @@ /* * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js index 3b4b39caa621..bc4e008d4b7b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js index dd49899527e5..986ddbac8f0b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js index e54cfe7c997d..51c123af5983 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 8e61d62f3539..657f7d1697f2 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2025 The Stdlib Authors. +* Copyright (c) 2026 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 5b7433578a658edd8493a2aa2af0b24697586c0c Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 9 Jan 2026 19:20:47 +0000 Subject: [PATCH 03/14] test: fix snanstdev benchmarks and tests --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../ndarray/snanstdev/benchmark/benchmark.js | 10 +- .../stats/base/ndarray/snanstdev/test/test.js | 116 ++++++++---------- 2 files changed, 53 insertions(+), 73 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js index 90dbad9b3d38..f1b3cf87b61a 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -24,7 +24,6 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/base/uniform' ); var bernoulli = require( '@stdlib/random/base/bernoulli' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); -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 format = require( '@stdlib/string/format' ); @@ -64,21 +63,14 @@ function createBenchmark( len ) { return benchmark; function benchmark( b ) { - var v; var i; b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v = snanstdev( [ x ] ); - if ( isnanf( v ) ) { - b.fail( 'should not return NaN' ); - } + snanstdev( [ x ] ); } b.toc(); - if ( isnanf( v ) ) { - b.fail( 'should not return NaN' ); - } b.pass( 'benchmark finished' ); b.end(); } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 657f7d1697f2..5a4976c46e28 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -22,6 +22,7 @@ var tape = require( 'tape' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var snanstdev = require( './../lib' ); @@ -57,103 +58,90 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function calculates the standard deviation of a one-dimensional ndarray, ignoring NaN values', function test( t ) { - var x; - var v; +tape( 'the function returns NaN for an empty ndarray', function test( t ) { + var x = new Float32Array( [] ); + var v = snanstdev( [ vector( x, 0, 1, 0 ) ] ); - x = new Float32Array( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); - v = snanstdev( [ vector( x, 7, 1, 0 ) ] ); - t.strictEqual( v > 0.0, true, 'returns expected value' ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); - x = new Float32Array( [ -4.0, NaN, -5.0 ] ); - v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); - t.strictEqual( v > 0.0, true, 'returns expected value' ); +tape( 'the function returns NaN when only one non-NaN value is present', function test( t ) { + var x = new Float32Array( [ 1.0 ] ); + var v = snanstdev( [ vector( x, 1, 1, 0 ) ] ); - x = new Float32Array( [ NaN ] ); - v = snanstdev( [ vector( x, 1, 1, 0 ) ] ); - t.strictEqual( isnanf( v ), true, 'returns expected value' ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); - x = new Float32Array( [ NaN, NaN ] ); - v = snanstdev( [ vector( x, 2, 1, 0 ) ] ); - t.strictEqual( isnanf( v ), true, 'returns expected value' ); +tape( 'the function returns NaN when all values are NaN', function test( t ) { + var x = new Float32Array( [ NaN, NaN ] ); + var v = snanstdev( [ vector( x, 2, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); -tape( 'if provided an empty ndarray, the function returns `NaN`', function test( t ) { - var x; - var v; +tape( 'the function returns +0 when all non-NaN values are equal', function test( t ) { + var x = new Float32Array( [ 2.0, 2.0, 2.0 ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); + + t.strictEqual( isPositiveZerof( v ), true, 'returns +0' ); + t.end(); +}); - x = new Float32Array( [] ); - v = snanstdev( [ vector( x, 0, 1, 0 ) ] ); +tape( 'the function returns a valid result when multiple non-NaN values are present', function test( t ) { + var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); - t.strictEqual( isnanf( v ), true, 'returns expected value' ); + t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); 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 + var x = new Float32Array([ + 1.0, + NaN, 2.0, - 2.0, // 1 - -7.0, - -2.0, // 2 + NaN, 3.0, - 4.0, // 3 - 2.0, - NaN, // 4 NaN ]); - v = snanstdev( [ vector( x, 5, 2, 0 ) ] ); - t.strictEqual( v > 0.0, true, 'returns expected value' ); + var v = snanstdev( [ vector( x, 3, 2, 0 ) ] ); + + t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); t.end(); }); tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { - var x; - var v; - - x = new Float32Array([ - NaN, // 4 + var x = new Float32Array([ NaN, - 1.0, // 3 - 2.0, - 2.0, // 2 - -7.0, - -2.0, // 1 3.0, - 4.0, // 0 - 2.0 + NaN, + 2.0, + NaN, + 1.0 ]); - v = snanstdev( [ vector( x, 5, -2, 8 ) ] ); - t.strictEqual( v > 0.0, true, 'returns expected value' ); + var v = snanstdev( [ vector( x, 3, -2, 5 ) ] ); + + t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); 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 + var x = new Float32Array([ + NaN, + 1.0, + NaN, 2.0, - -2.0, // 1 - -2.0, - 2.0, // 2 - 3.0, - 4.0, // 3 - 6.0, - NaN, // 4 - NaN + NaN, + 3.0 ]); - v = snanstdev( [ vector( x, 5, 2, 1 ) ] ); - t.strictEqual( v > 0.0, true, 'returns expected value' ); + var v = snanstdev( [ vector( x, 3, 2, 1 ) ] ); + + t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); t.end(); }); From bb8a42e9ce3037cff748626c480289a75e9451df Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 9 Jan 2026 19:24:53 +0000 Subject: [PATCH 04/14] test: fix snanstdev benchmarks and tests --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/test/test.js | 90 ++++++++++--------- 1 file changed, 49 insertions(+), 41 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 5a4976c46e28..1bd26de3ce4f 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -58,90 +58,98 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function returns NaN for an empty ndarray', function test( t ) { - var x = new Float32Array( [] ); - var v = snanstdev( [ vector( x, 0, 1, 0 ) ] ); +tape( 'the function returns NaN when all values are NaN', function test( t ) { + var x; + var v; + + x = new Float32Array( [ NaN, NaN, NaN ] ); + v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); tape( 'the function returns NaN when only one non-NaN value is present', function test( t ) { - var x = new Float32Array( [ 1.0 ] ); - var v = snanstdev( [ vector( x, 1, 1, 0 ) ] ); - - t.strictEqual( isnanf( v ), true, 'returns NaN' ); - t.end(); -}); + var x; + var v; -tape( 'the function returns NaN when all values are NaN', function test( t ) { - var x = new Float32Array( [ NaN, NaN ] ); - var v = snanstdev( [ vector( x, 2, 1, 0 ) ] ); + x = new Float32Array( [ NaN, 3.0, NaN ] ); + v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); -tape( 'the function returns +0 when all non-NaN values are equal', function test( t ) { - var x = new Float32Array( [ 2.0, 2.0, 2.0 ] ); - var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); +tape( 'the function returns +0 when two or more non-NaN values are equal', function test( t ) { + var x; + var v; + + x = new Float32Array( [ 3.0, 3.0, NaN, 3.0 ] ); + v = snanstdev( [ vector( x, 4, 1, 0 ) ] ); t.strictEqual( isPositiveZerof( v ), true, 'returns +0' ); t.end(); }); tape( 'the function returns a valid result when multiple non-NaN values are present', function test( t ) { - var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); - var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); + var x; + var v; - t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); + x = new Float32Array( [ 1.0, 2.0, NaN, 3.0 ] ); + v = snanstdev( [ vector( x, 4, 1, 0 ) ] ); + + t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); t.end(); }); tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { - var x = new Float32Array([ - 1.0, + var x; + var v; + + x = new Float32Array([ + 1.0, // 0 NaN, - 2.0, + 2.0, // 1 NaN, - 3.0, - NaN + 3.0 // 2 ]); - var v = snanstdev( [ vector( x, 3, 2, 0 ) ] ); - - t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); + v = snanstdev( [ vector( x, 3, 2, 0 ) ] ); + t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); t.end(); }); tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { - var x = new Float32Array([ - NaN, - 3.0, + var x; + var v; + + x = new Float32Array([ + 3.0, // 2 NaN, - 2.0, + 2.0, // 1 NaN, - 1.0 + 1.0 // 0 ]); - var v = snanstdev( [ vector( x, 3, -2, 5 ) ] ); - - t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); + v = snanstdev( [ vector( x, 3, -2, 4 ) ] ); + t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); t.end(); }); tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { - var x = new Float32Array([ + var x; + var v; + + x = new Float32Array([ NaN, - 1.0, + 1.0, // 0 NaN, - 2.0, + 2.0, // 1 NaN, - 3.0 + 3.0 // 2 ]); - var v = snanstdev( [ vector( x, 3, 2, 1 ) ] ); - - t.strictEqual( isnanf( v ) || v >= 0.0, true, 'returns NaN or a non-negative number' ); + v = snanstdev( [ vector( x, 3, 2, 1 ) ] ); + t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); t.end(); }); From 7b8ef96b5609187426be5d2db4d5350abd6dc289 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 9 Jan 2026 19:27:35 +0000 Subject: [PATCH 05/14] test: align snanstdev tests with snanstdevpn semantics --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/test/test.js | 102 ++++++------------ 1 file changed, 35 insertions(+), 67 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 1bd26de3ce4f..15ecbbeaaae1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -22,7 +22,6 @@ var tape = require( 'tape' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); -var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var snanstdev = require( './../lib' ); @@ -30,16 +29,6 @@ var snanstdev = 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' ); } @@ -58,98 +47,77 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function returns NaN when all values are NaN', function test( t ) { - var x; - var v; - - x = new Float32Array( [ NaN, NaN, NaN ] ); - v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); +tape( 'the function returns NaN for an empty ndarray', function test( t ) { + var x = new Float32Array( [] ); + var v = snanstdev( [ vector( x, 0, 1, 0 ) ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); -tape( 'the function returns NaN when only one non-NaN value is present', function test( t ) { - var x; - var v; - - x = new Float32Array( [ NaN, 3.0, NaN ] ); - v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); +tape( 'the function returns NaN when all values are NaN', function test( t ) { + var x = new Float32Array( [ NaN, NaN, NaN ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); -tape( 'the function returns +0 when two or more non-NaN values are equal', function test( t ) { - var x; - var v; - - x = new Float32Array( [ 3.0, 3.0, NaN, 3.0 ] ); - v = snanstdev( [ vector( x, 4, 1, 0 ) ] ); +tape( 'the function returns NaN when only one non-NaN value is present', function test( t ) { + var x = new Float32Array( [ NaN, 2.0, NaN ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); - t.strictEqual( isPositiveZerof( v ), true, 'returns +0' ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); -tape( 'the function returns a valid result when multiple non-NaN values are present', function test( t ) { - var x; - var v; - - x = new Float32Array( [ 1.0, 2.0, NaN, 3.0 ] ); - v = snanstdev( [ vector( x, 4, 1, 0 ) ] ); +tape( 'the function supports ndarrays with multiple non-NaN values', function test( t ) { + var x = new Float32Array( [ 1.0, 2.0, NaN, 3.0 ] ); + var v = snanstdev( [ vector( x, 4, 1, 0 ) ] ); - t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); + t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); 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 +tape( 'the function supports non-unit strides', function test( t ) { + var x = new Float32Array([ + 1.0, NaN, - 2.0, // 1 + 2.0, NaN, - 3.0 // 2 + 3.0 ]); - v = snanstdev( [ vector( x, 3, 2, 0 ) ] ); - t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); + var v = snanstdev( [ vector( x, 3, 2, 0 ) ] ); + t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); t.end(); }); -tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { - var x; - var v; - - x = new Float32Array([ - 3.0, // 2 +tape( 'the function supports negative strides', function test( t ) { + var x = new Float32Array([ + 3.0, NaN, - 2.0, // 1 + 2.0, NaN, - 1.0 // 0 + 1.0 ]); - v = snanstdev( [ vector( x, 3, -2, 4 ) ] ); - t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); + var v = snanstdev( [ vector( x, 3, -2, 4 ) ] ); + t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); t.end(); }); -tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { - var x; - var v; - - x = new Float32Array([ +tape( 'the function supports non-zero offsets', function test( t ) { + var x = new Float32Array([ NaN, - 1.0, // 0 + 1.0, NaN, - 2.0, // 1 + 2.0, NaN, - 3.0 // 2 + 3.0 ]); - v = snanstdev( [ vector( x, 3, 2, 1 ) ] ); - t.ok( isnanf( v ) === false && v >= 0.0, 'returns NaN or a non-negative number' ); + var v = snanstdev( [ vector( x, 3, 2, 1 ) ] ); + t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); t.end(); }); From 05ec5ed0818141496f7c9a68f48a7774aea32d92 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 17:59:29 +0000 Subject: [PATCH 06/14] fix: add correction parameter to snanstdev ndarray API --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/README.md | 16 +++++--- .../ndarray/snanstdev/benchmark/benchmark.js | 14 ++++++- .../base/ndarray/snanstdev/docs/repl.txt | 41 +++++++++++++++---- .../ndarray/snanstdev/docs/types/index.d.ts | 13 +++--- .../stats/base/ndarray/snanstdev/lib/index.js | 7 +++- .../stats/base/ndarray/snanstdev/lib/main.js | 14 +++++-- .../stats/base/ndarray/snanstdev/test/test.js | 38 +++++++++++------ 7 files changed, 104 insertions(+), 39 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md index f2b43063fe53..d259efb76681 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/README.md @@ -50,13 +50,17 @@ var ndarray = require( '@stdlib/ndarray/base/ctor' ); var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); -var v = snanstdev( [ x ] ); -// returns +var c = new ndarray( 'generic', [ 1 ], [], [ 0 ], 0, 'row-major' ); + +var v = snanstdev( [ x, c ] ); +// returns ~1.0 ``` The function has the following parameters: -- **arrays**: array-like object containing a one-dimensional input ndarray. +- **arrays**: array-like object containing: + - a one-dimensional input ndarray + - a zero-dimensional ndarray specifying a degrees of freedom adjustment @@ -83,7 +87,6 @@ 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 snanstdev = require( '@stdlib/stats/base/ndarray/snanstdev' ); function rand() { @@ -95,9 +98,10 @@ function rand() { var xbuf = filledarrayBy( 10, 'float32', rand ); var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); -console.log( ndarray2array( x ) ); -var v = snanstdev( [ x ] ); +var c = new ndarray( 'generic', [ 1 ], [], [ 0 ], 0, 'row-major' ); + +var v = snanstdev( [ x, c ] ); console.log( v ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js index f1b3cf87b61a..9d76ae5fa5a5 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -25,6 +25,7 @@ var uniform = require( '@stdlib/random/base/uniform' ); var bernoulli = require( '@stdlib/random/base/bernoulli' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); var pow = require( '@stdlib/math/base/special/pow' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; @@ -54,23 +55,34 @@ function rand() { * @returns {Function} benchmark function */ function createBenchmark( len ) { + var correction; var xbuf; var x; xbuf = filledarrayBy( len, 'float32', rand ); x = new ndarray( 'float32', xbuf, [ len ], [ 1 ], 0, 'row-major' ); + correction = 1; + return benchmark; function benchmark( b ) { + var v; var i; b.tic(); for ( i = 0; i < b.iterations; i++ ) { - snanstdev( [ x ] ); + v = snanstdev( [ x, correction ] ); + 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(); } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt index 0b21379350fc..a4b416c0f288 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/repl.txt @@ -3,29 +3,52 @@ Computes the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. - If provided an empty ndarray, the function returns `NaN`. + If provided an empty one-dimensional ndarray, the function returns `NaN`. + + If the number of non-NaN elements minus the degrees of freedom adjustment + is less than or equal to `0`, the function returns `NaN`. Parameters ---------- arrays: ArrayLikeObject - Array-like object containing a one-dimensional input ndarray. + Array-like object containing two elements: a one-dimensional input + ndarray and a zero-dimensional ndarray specifying the degrees of + freedom adjustment. Providing a non-zero degrees of freedom adjustment + has the effect of adjusting the divisor during the calculation of the + standard deviation according to `N-c`, where `N` is the number of + non-NaN elements in the input ndarray and `c` corresponds to the + provided degrees of freedom adjustment. When computing the standard + deviation of a population, setting this parameter to `0` is the + standard choice. When computing the corrected sample standard deviation, + setting this parameter to `1` is the standard choice (commonly referred + to as Bessel's correction). Returns ------- out: number - Computed standard deviation. + The standard deviation. Examples -------- - > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] ); + // Create input ndarray: + > 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 st = [ 1 ]; + > var oo = 0; > var ord = 'row-major'; - > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); - > {{alias}}( [ x ] ) - NaN + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); + + // Create correction ndarray: + > var opts = { 'dtype': dt }; + > var correction = + ... {{alias:@stdlib/ndarray/from-scalar}}( 1.0, opts ); + + // Compute the standard deviation: + > {{alias}}( [ x, correction ] ) + ~2.0817 See Also -------- diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts index f76b44c9a32d..1601119d8466 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/index.d.ts @@ -20,12 +20,12 @@ /// -import { float32ndarray } from '@stdlib/types/ndarray'; +import { float32ndarray, ndarray } from '@stdlib/types/ndarray'; /** * Computes the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. * -* @param arrays - array-like object containing an input ndarray +* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment * @returns computed standard deviation * * @example @@ -35,10 +35,13 @@ import { float32ndarray } from '@stdlib/types/ndarray'; * var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * -* var v = snanstdev( [ x ] ); -* // returns +* // Degrees of freedom adjustment: +* var c = new ndarray( 'generic', [ 1 ], [], [ 0 ], 0, 'row-major' ); +* +* var v = snanstdev( [ x, c ] ); +* // returns 1.0 */ -declare function snanstdev( arrays: [ float32ndarray ] ): number; +declare function snanstdev( arrays: [ float32ndarray, ndarray ] ): number; // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js index 986ddbac8f0b..39661a8de4a8 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/index.js @@ -31,8 +31,11 @@ * var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * -* var v = snanstdev( [ x ] ); -* // returns +* // Degrees of freedom adjustment: +* var c = new ndarray( 'generic', [ 1 ], [], [ 0 ], 0, 'row-major' ); +* +* var v = snanstdev( [ x, c ] ); +* // returns ~1.0 */ // MODULES // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js index 51c123af5983..0b749189eb88 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js @@ -20,6 +20,7 @@ // MODULES // +var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); var getStride = require( '@stdlib/ndarray/base/stride' ); var getOffset = require( '@stdlib/ndarray/base/offset' ); @@ -32,7 +33,7 @@ var strided = require( '@stdlib/stats/base/snanstdevpn' ).ndarray; /** * Computes the standard deviation of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values. * -* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray +* @param {ArrayLikeObject} arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment * @returns {number} standard deviation * * @example @@ -42,12 +43,17 @@ var strided = require( '@stdlib/stats/base/snanstdevpn' ).ndarray; * var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * -* var v = snanstdev( [ x ] ); -* // returns NaN +* // Degrees of freedom adjustment: +* var c = new ndarray( 'generic', [ 1 ], [], [ 0 ], 0, 'row-major' ); +* +* var v = snanstdev( [ x, c ] ); +* // returns 1.0 */ function snanstdev( arrays ) { + var correction = ndarraylike2scalar( arrays[ 1 ] ); var x = arrays[ 0 ]; - return strided(numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x )); // eslint-disable-line max-len + + return strided(numelDimension( x, 0 ), correction, getData( x ), getStride( x, 0 ), getOffset( x )); } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 15ecbbeaaae1..6ea3900e591d 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -29,6 +29,16 @@ var snanstdev = 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' ); } @@ -49,7 +59,7 @@ tape( 'the function has an arity of 1', function test( t ) { tape( 'the function returns NaN for an empty ndarray', function test( t ) { var x = new Float32Array( [] ); - var v = snanstdev( [ vector( x, 0, 1, 0 ) ] ); + var v = snanstdev( [ vector( x, 0, 1, 0 ), 1 ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); @@ -57,7 +67,7 @@ tape( 'the function returns NaN for an empty ndarray', function test( t ) { tape( 'the function returns NaN when all values are NaN', function test( t ) { var x = new Float32Array( [ NaN, NaN, NaN ] ); - var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ), 1 ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); @@ -65,21 +75,23 @@ tape( 'the function returns NaN when all values are NaN', function test( t ) { tape( 'the function returns NaN when only one non-NaN value is present', function test( t ) { var x = new Float32Array( [ NaN, 2.0, NaN ] ); - var v = snanstdev( [ vector( x, 3, 1, 0 ) ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ), 1 ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); }); -tape( 'the function supports ndarrays with multiple non-NaN values', function test( t ) { +tape( 'the function computes the standard deviation for multiple non-NaN values', function test( t ) { + var expected = 1.0; var x = new Float32Array( [ 1.0, 2.0, NaN, 3.0 ] ); - var v = snanstdev( [ vector( x, 4, 1, 0 ) ] ); + var v = snanstdev( [ vector( x, 4, 1, 0 ), 1 ] ); - t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); + t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); tape( 'the function supports non-unit strides', function test( t ) { + var expected = 1.0; var x = new Float32Array([ 1.0, NaN, @@ -88,12 +100,13 @@ tape( 'the function supports non-unit strides', function test( t ) { 3.0 ]); - var v = snanstdev( [ vector( x, 3, 2, 0 ) ] ); - t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); + var v = snanstdev( [ vector( x, 3, 2, 0 ), 1 ] ); + t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); tape( 'the function supports negative strides', function test( t ) { + var expected = 1.0; var x = new Float32Array([ 3.0, NaN, @@ -102,12 +115,13 @@ tape( 'the function supports negative strides', function test( t ) { 1.0 ]); - var v = snanstdev( [ vector( x, 3, -2, 4 ) ] ); - t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); + var v = snanstdev( [ vector( x, 3, -2, 4 ), 1 ] ); + t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); tape( 'the function supports non-zero offsets', function test( t ) { + var expected = 1.0; var x = new Float32Array([ NaN, 1.0, @@ -117,7 +131,7 @@ tape( 'the function supports non-zero offsets', function test( t ) { 3.0 ]); - var v = snanstdev( [ vector( x, 3, 2, 1 ) ] ); - t.ok( isnanf( v ) || v >= 0.0, 'returns NaN or non-negative number' ); + var v = snanstdev( [ vector( x, 3, 2, 1 ), 1 ] ); + t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); From e303e8bb5d27053b367176da71b1f939de8f14f0 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 18:00:23 +0000 Subject: [PATCH 07/14] fix: add correction parameter to snanstdev ndarray API --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/ndarray/snanstdev/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js index 0b749189eb88..071737120416 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js @@ -53,7 +53,7 @@ function snanstdev( arrays ) { var correction = ndarraylike2scalar( arrays[ 1 ] ); var x = arrays[ 0 ]; - return strided(numelDimension( x, 0 ), correction, getData( x ), getStride( x, 0 ), getOffset( x )); + return strided(numelDimension( x, 0 ), correction, getData( x ), getStride( x, 0 ), getOffset( x )); // eslint-disable-line max-len } From 0caca5ce957e42f41b678a79417ae92c883d8409 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 18:13:20 +0000 Subject: [PATCH 08/14] fix: add correction parameter to snanstdev ndarray API --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../ndarray/snanstdev/benchmark/benchmark.js | 40 ++++++++++--------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js index 9d76ae5fa5a5..2917a6a70ccb 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -21,31 +21,25 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); -var pow = require( '@stdlib/math/base/special/pow' ); 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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; var snanstdev = require( './../lib' ); -// FUNCTIONS // +// VARIABLES // -/** -* Returns a random number. -* -* @private -* @returns {number} random number or `NaN` -*/ -function rand() { - if ( bernoulli( 0.8 ) < 1 ) { - return NaN; - } - return uniform( -10.0, 10.0 ); -} +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // /** * Creates a benchmark function. @@ -58,11 +52,19 @@ function createBenchmark( len ) { var correction; var xbuf; var x; + var i; + + xbuf = uniform( len, -10.0, 10.0, options ); - xbuf = filledarrayBy( len, 'float32', rand ); - x = new ndarray( 'float32', xbuf, [ len ], [ 1 ], 0, 'row-major' ); + // Randomly introduce NaNs: + for ( i = 0; i < len; i++ ) { + if ( bernoulli( 0.8 ) < 1 ) { + xbuf[ i ] = NaN; + } + } - correction = 1; + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + correction = scalar2ndarray( 1.0, options ); return benchmark; From 421ea026a45a2f589d5f141c3c8b04da0970360e Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 19:23:30 +0000 Subject: [PATCH 09/14] fix: add correction parameter to snanstdev ndarray API --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../base/ndarray/snanstdev/benchmark/benchmark.js | 10 ---------- .../@stdlib/stats/base/ndarray/snanstdev/lib/main.js | 4 ++-- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js index 2917a6a70ccb..efe09d911a6d 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -22,7 +22,6 @@ 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' ); @@ -52,17 +51,8 @@ function createBenchmark( len ) { var correction; var xbuf; var x; - var i; xbuf = uniform( len, -10.0, 10.0, options ); - - // Randomly introduce NaNs: - 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' ); correction = scalar2ndarray( 1.0, options ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js index 071737120416..0f22d6462581 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js @@ -38,13 +38,13 @@ var strided = require( '@stdlib/stats/base/snanstdevpn' ).ndarray; * * @example * var Float32Array = require( '@stdlib/array/float32' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = new Float32Array( [ 1.0, 3.0, NaN, 2.0 ] ); * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * -* // Degrees of freedom adjustment: -* var c = new ndarray( 'generic', [ 1 ], [], [ 0 ], 0, 'row-major' ); +* var c = scalar2ndarray( 1.0, { 'dtype': 'float32' } ); * * var v = snanstdev( [ x, c ] ); * // returns 1.0 From 26867a70141b4540eafbcfd6293e2900fad2f9ac Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 19:29:00 +0000 Subject: [PATCH 10/14] fix: add correction parameter to snanstdev ndarray API --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/test/test.js | 24 +++++++++++++------ 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 6ea3900e591d..7d9ca84c9dc9 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -24,9 +24,19 @@ 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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var snanstdev = require( './../lib' ); +// VARIABLES // + +var opts = { + 'dtype': 'float32' +}; + +var correction = scalar2ndarray( 1.0, opts ); + + // FUNCTIONS // /** @@ -59,7 +69,7 @@ tape( 'the function has an arity of 1', function test( t ) { tape( 'the function returns NaN for an empty ndarray', function test( t ) { var x = new Float32Array( [] ); - var v = snanstdev( [ vector( x, 0, 1, 0 ), 1 ] ); + var v = snanstdev( [ vector( x, 0, 1, 0 ), correction ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); @@ -67,7 +77,7 @@ tape( 'the function returns NaN for an empty ndarray', function test( t ) { tape( 'the function returns NaN when all values are NaN', function test( t ) { var x = new Float32Array( [ NaN, NaN, NaN ] ); - var v = snanstdev( [ vector( x, 3, 1, 0 ), 1 ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ), correction ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); @@ -75,7 +85,7 @@ tape( 'the function returns NaN when all values are NaN', function test( t ) { tape( 'the function returns NaN when only one non-NaN value is present', function test( t ) { var x = new Float32Array( [ NaN, 2.0, NaN ] ); - var v = snanstdev( [ vector( x, 3, 1, 0 ), 1 ] ); + var v = snanstdev( [ vector( x, 3, 1, 0 ), correction ] ); t.strictEqual( isnanf( v ), true, 'returns NaN' ); t.end(); @@ -84,7 +94,7 @@ tape( 'the function returns NaN when only one non-NaN value is present', functio tape( 'the function computes the standard deviation for multiple non-NaN values', function test( t ) { var expected = 1.0; var x = new Float32Array( [ 1.0, 2.0, NaN, 3.0 ] ); - var v = snanstdev( [ vector( x, 4, 1, 0 ), 1 ] ); + var v = snanstdev( [ vector( x, 4, 1, 0 ), correction ] ); t.strictEqual( v, expected, 'returns expected value' ); t.end(); @@ -100,7 +110,7 @@ tape( 'the function supports non-unit strides', function test( t ) { 3.0 ]); - var v = snanstdev( [ vector( x, 3, 2, 0 ), 1 ] ); + var v = snanstdev( [ vector( x, 3, 2, 0 ), correction ] ); t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); @@ -115,7 +125,7 @@ tape( 'the function supports negative strides', function test( t ) { 1.0 ]); - var v = snanstdev( [ vector( x, 3, -2, 4 ), 1 ] ); + var v = snanstdev( [ vector( x, 3, -2, 4 ), correction ] ); t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); @@ -131,7 +141,7 @@ tape( 'the function supports non-zero offsets', function test( t ) { 3.0 ]); - var v = snanstdev( [ vector( x, 3, 2, 1 ), 1 ] ); + var v = snanstdev( [ vector( x, 3, 2, 1 ), correction ] ); t.strictEqual( v, expected, 'returns expected value' ); t.end(); }); From 384bf5b90896ca065e2fc0e01561df2960c7deb1 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Sat, 10 Jan 2026 19:35:17 +0000 Subject: [PATCH 11/14] docs: update snanstdev example to include correction ndarray --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/examples/index.js | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js index bc4e008d4b7b..ad0d37184db9 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/examples/index.js @@ -22,6 +22,7 @@ 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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); var snanstdev = require( './../lib' ); @@ -32,10 +33,15 @@ function rand() { return uniform( -50.0, 50.0 ); } +// Create input ndarray: var xbuf = filledarrayBy( 10, 'float32', rand ); var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); - console.log( ndarray2array( x ) ); -var v = snanstdev( [ x ] ); +var opts = { + 'dtype': 'float32' +}; +var correction = scalar2ndarray( 1.0, opts ); + +var v = snanstdev( [ x, correction ] ); console.log( v ); From 1dd7e9099e580416b63e19ba84c249300a99a105 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Tue, 13 Jan 2026 15:49:04 +0000 Subject: [PATCH 12/14] fix: align snanstdev docs test and typings with correction semantics --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../base/ndarray/snanstdev/docs/types/test.ts | 37 +++++++++++-------- .../stats/base/ndarray/snanstdev/lib/main.js | 2 +- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts index 970695353cd5..c79106d85744 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/docs/types/test.ts @@ -18,8 +18,9 @@ /* eslint-disable space-in-parens */ -import zeros = require( '@stdlib/ndarray/zeros' ); -import snanstdev = require( './index' ); +import zeros = require('@stdlib/ndarray/zeros'); +import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +import snanstdev = require('./index'); // TESTS // @@ -29,29 +30,35 @@ import snanstdev = require( './index' ); const x = zeros( [ 10 ], { 'dtype': 'float32' }); - - snanstdev( [ x ] ); // $ExpectType number + const correction = scalar2ndarray( 1.0, { + 'dtype': 'float32' + }); + snanstdev( [ x, correction ] ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... { - snanstdev( '10' ); // $ExpectError - snanstdev( 10 ); // $ExpectError - snanstdev( true ); // $ExpectError - snanstdev( false ); // $ExpectError - snanstdev( null ); // $ExpectError - snanstdev( undefined ); // $ExpectError - snanstdev( [] ); // $ExpectError - snanstdev( {} ); // $ExpectError - snanstdev( ( x: number ): number => x ); // $ExpectError + snanstdev('10'); // $ExpectError + snanstdev(10); // $ExpectError + snanstdev(true); // $ExpectError + snanstdev(false); // $ExpectError + snanstdev(null); // $ExpectError + snanstdev(undefined); // $ExpectError + snanstdev([]); // $ExpectError + snanstdev({}); // $ExpectError + snanstdev((x: number): number => x); // $ExpectError } // The compiler throws an error if the function is provided an unsupported number of arguments... { - const x = zeros( [ 10 ], { + const x = zeros([10], { + 'dtype': 'float32' + }); + + const correction = scalar2ndarray( 1.0, { 'dtype': 'float32' }); snanstdev(); // $ExpectError - snanstdev( [ x ], {} ); // $ExpectError + snanstdev( [ x, correction ], 10 ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js index 0f22d6462581..bf87029c50c9 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/lib/main.js @@ -53,7 +53,7 @@ function snanstdev( arrays ) { var correction = ndarraylike2scalar( arrays[ 1 ] ); var x = arrays[ 0 ]; - return strided(numelDimension( x, 0 ), correction, getData( x ), getStride( x, 0 ), getOffset( x )); // eslint-disable-line max-len + return strided( numelDimension( x, 0 ), correction, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len } From ff870e172026ee52dc66c81ab506d17561757dcf Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Tue, 13 Jan 2026 19:51:05 +0000 Subject: [PATCH 13/14] test: align snanstdev test comments with ndarray semantics --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/test/test.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js index 7d9ca84c9dc9..b95e4fe6d096 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/test/test.js @@ -103,11 +103,11 @@ tape( 'the function computes the standard deviation for multiple non-NaN values' tape( 'the function supports non-unit strides', function test( t ) { var expected = 1.0; var x = new Float32Array([ - 1.0, + 1.0, // 0 NaN, - 2.0, + 2.0, // 1 NaN, - 3.0 + 3.0 // 2 ]); var v = snanstdev( [ vector( x, 3, 2, 0 ), correction ] ); @@ -118,11 +118,11 @@ tape( 'the function supports non-unit strides', function test( t ) { tape( 'the function supports negative strides', function test( t ) { var expected = 1.0; var x = new Float32Array([ - 3.0, + 3.0, // 2 NaN, - 2.0, + 2.0, // 1 NaN, - 1.0 + 1.0 // 0 ]); var v = snanstdev( [ vector( x, 3, -2, 4 ), correction ] ); @@ -134,11 +134,11 @@ tape( 'the function supports non-zero offsets', function test( t ) { var expected = 1.0; var x = new Float32Array([ NaN, - 1.0, + 1.0, // 0 NaN, - 2.0, + 2.0, // 1 NaN, - 3.0 + 3.0 // 2 ]); var v = snanstdev( [ vector( x, 3, 2, 1 ), correction ] ); From c8099ce8054e4bfa619ca8afd62bc56c7fe568ae Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Wed, 14 Jan 2026 19:20:34 +0000 Subject: [PATCH 14/14] docs: add missing JSDoc in benchmark files --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/ndarray/snanstdev/benchmark/benchmark.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js index efe09d911a6d..90cc86d23da0 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanstdev/benchmark/benchmark.js @@ -58,6 +58,12 @@ function createBenchmark( len ) { return benchmark; + /** + * Runs a benchmark. + * + * @private + * @param {Benchmark} b - benchmark instance + */ function benchmark( b ) { var v; var i;