From 39d21177465289648070080d8237d4bf2f6cb320 Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Sun, 4 Jan 2026 01:02:03 +0530 Subject: [PATCH 1/2] feat: add `stats/base/ndarray/dsem` --- 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 --- --- .../@stdlib/stats/base/ndarray/dsem/README.md | 148 +++++++++++ .../base/ndarray/dsem/benchmark/benchmark.js | 106 ++++++++ .../stats/base/ndarray/dsem/docs/repl.txt | 41 +++ .../base/ndarray/dsem/docs/types/index.d.ts | 52 ++++ .../base/ndarray/dsem/docs/types/test.ts | 64 +++++ .../stats/base/ndarray/dsem/examples/index.js | 37 +++ .../stats/base/ndarray/dsem/lib/index.js | 55 ++++ .../stats/base/ndarray/dsem/lib/main.js | 69 +++++ .../stats/base/ndarray/dsem/package.json | 65 +++++ .../stats/base/ndarray/dsem/test/test.js | 250 ++++++++++++++++++ 10 files changed, 887 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md new file mode 100644 index 000000000000..8e023c7b8edc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md @@ -0,0 +1,148 @@ + + +# dsem + +> Calculate the [standard error of the mean][standard-error] of a one-dimensional double-precision floating-point ndarray. + +
+ +The [standard error of the mean][standard-error] of a finite size sample of size `n` is given by + + + +```math +\sigma_{\bar{x}} = \frac{\sigma}{\sqrt{n}} +``` + + + + + +where `σ` is the population [standard deviation][standard-deviation]. + +Often in the analysis of data, the true population [standard deviation][standard-deviation] is not known _a priori_ and must be estimated from a sample drawn from the population distribution. In this scenario, one must use a sample [standard deviation][standard-deviation] to compute an estimate for the [standard error of the mean][standard-error] + + + +```math +\sigma_{\bar{x}} \approx \frac{s}{\sqrt{n}} +``` + + + + + +where `s` is the sample [standard deviation][standard-deviation]. + +
+ + + +
+ +## Usage + +```javascript +var dsem = require( '@stdlib/stats/base/ndarray/dsem' ); +``` + +#### dsem( arrays ) + +Computes the [standard error of the mean][standard-error] of a one-dimensional double-precision floating-point ndarray. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); + +var opts = { + 'dtype': 'float64' +}; + +var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); + +var correction = scalar2ndarray( 1.0, opts ); + +var v = dsem( [ x, correction ] ); +// returns ~1.20185 +``` + +The function accepts the following arguments: + +- **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment. + +
+ + + +
+ +## Examples + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); +var dsem = require( '@stdlib/stats/base/ndarray/dsem' ); + +var opts = { + 'dtype': 'float64' +}; + +var xbuf = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +var x = new ndarray( opts.dtype, xbuf, [ 4 ], [ 2 ], 1, 'row-major' ); + +var correction = scalar2ndarray( 1.0, opts ); + +var v = dsem( [ x, correction ] ); +// returns 1.25 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[standard-error]: https://en.wikipedia.org/wiki/Standard_error + +[standard-deviation]: https://en.wikipedia.org/wiki/Standard_deviation + +
+ + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js new file mode 100644 index 000000000000..7bf8bcaabd62 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dsem = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var correction; + var xbuf; + var x; + + xbuf = uniform( len, -10.0, 10.0, options ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + correction = scalar2ndarray( 1.0, options ); + + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = dsem( [ x, correction ] ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s::len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/repl.txt new file mode 100644 index 000000000000..501f7e53f0d9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/repl.txt @@ -0,0 +1,41 @@ + +{{alias}}( arrays ) + Computes the standard error of the mean of a one-dimensional + double-precision floating-point ndarray. + + If provided an empty one-dimensional ndarray, the function returns `NaN`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray and a + zero-dimensional ndarray specifying a degrees of freedom adjustment. + + Returns + ------- + out: number + The standard error of the mean. + + Examples + -------- + // Create input ndarray: + > var Float64Array = require( '@stdlib/array/float64' ); + > var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + > var dt = 'float64'; + > var sh = [ xbuf.length ]; + > var st = [ 1 ]; + > var oo = 0; + > var ord = 'row-major'; + > 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 error of the mean: + > {{alias}}( [ x, correction ] ) + ~1.20185 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts new file mode 100644 index 000000000000..2be977107160 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts @@ -0,0 +1,52 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { typedndarray } from '@stdlib/types/ndarray'; + +/** +* Computes the standard error of the mean of a one-dimensional double-precision floating-point ndarray. +* +* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment +* @returns standard error of the mean +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var opts = { +* 'dtype': 'float64' +* }; +* +* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* var correction = scalar2ndarray( 1.0, opts ); +* +* var v = dsem( [ x, correction ] ); +* // returns ~1.20185 +*/ +declare function dsem = typedndarray>( arrays: [ T, T ] ): number; + + +// EXPORTS // + +export = dsem; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/test.ts new file mode 100644 index 000000000000..a13bff73db47 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/test.ts @@ -0,0 +1,64 @@ +/* +* @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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +import dsem = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const correction = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + dsem( [ x, correction ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dsem( '10' ); // $ExpectError + dsem( 10 ); // $ExpectError + dsem( true ); // $ExpectError + dsem( false ); // $ExpectError + dsem( null ); // $ExpectError + dsem( undefined ); // $ExpectError + dsem( [] ); // $ExpectError + dsem( {} ); // $ExpectError + dsem( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + const correction = scalar2ndarray( 1.0, { + 'dtype': 'float64' + }); + + dsem(); // $ExpectError + dsem( [ x, correction ], 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/examples/index.js new file mode 100644 index 000000000000..e758b9e73877 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/examples/index.js @@ -0,0 +1,37 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dsem = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var xbuf = discreteUniform( 10, -50, 50, opts ); +var x = new ndarray( opts.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var correction = scalar2ndarray( 1.0, opts ); +var v = dsem( [ x, correction ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js new file mode 100644 index 000000000000..872074a79085 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js @@ -0,0 +1,55 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Compute the standard error of the mean of a one-dimensional double-precision floating-point ndarray. +* +* @module @stdlib/stats/base/ndarray/dsem +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/ctor' ); +* var dsem = require( '@stdlib/stats/base/ndarray/dsem' ); +* +* var opts = { +* 'dtype': 'float64' +* }; +* +* // Define a one-dimensional input ndarray: +* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* // Specify the degrees of freedom adjustment: +* var correction = scalar2ndarray( 1.0, opts ); +* +* // Compute the standard error of the mean: +* var v = dsem( [ x, correction ] ); +* // returns ~1.20185 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js new file mode 100644 index 000000000000..915687b6b052 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js @@ -0,0 +1,69 @@ +/** +* @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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +var strided = require( '@stdlib/stats/strided/dsem' ).ndarray; + + +// MAIN // + +/** +* Computes the standard error of the mean of a one-dimensional double-precision floating-point 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 error of the mean +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var opts = { +* 'dtype': 'float64' +* }; +* +* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] ); +* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var correction = scalar2ndarray( 1.0, opts ); +* +* var v = dsem( [ x, correction ] ); +* // returns ~1.20185 +*/ +function dsem( arrays ) { + var correction; + var x; + + x = arrays[ 0 ]; + correction = ndarraylike2scalar( arrays[ 1 ] ); + + return strided( numelDimension( x, 0 ), correction, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = dsem; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/package.json new file mode 100644 index 000000000000..afe105259032 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/stats/base/ndarray/dsem", + "version": "0.0.0", + "description": "Compute the standard error of the mean of a one-dimensional double-precision floating-point ndarray.", + "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 error", + "sem", + "mean", + "error", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js new file mode 100644 index 000000000000..76d0fd32cce7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js @@ -0,0 +1,250 @@ +/** +* @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 sqrt = require( '@stdlib/math/base/special/sqrt' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var dsem = 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( 'float64', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dsem, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dsem.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the standard error of the mean of a one-dimensional ndarray', function test( t ) { + var correction; + var expected; + var opts; + var x; + var v; + + opts = { + 'dtype': 'float64' + }; + + x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ] ); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, x.length, 1, 0 ), correction ] ); + expected = sqrt( 53.5/(x.length-1) ) / sqrt( x.length ); + if ( abs( v - expected ) < 5.0*EPS ) { + t.ok( true, 'returns expected value' ); + } else { + t.strictEqual( v, expected, 'returns expected value' ); + } + + x = new Float64Array( [ -4.0, -5.0 ] ); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, x.length, 1, 0 ), correction ] ); + expected = sqrt( 0.5 ) / sqrt( x.length ); + if ( abs( v - expected ) < 5.0*EPS ) { + t.ok( true, 'returns expected value' ); + } else { + t.strictEqual( v, expected, 'returns expected value' ); + } + + x = new Float64Array( [ NaN ] ); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, x.length, 1, 0 ), correction ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Float64Array( [ NaN, NaN ] ); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, x.length, 1, 0 ), correction ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty ndarray, the function returns `NaN`', function test( t ) { + var correction; + var opts; + var x; + var v; + + opts = { + 'dtype': 'float64' + }; + + x = new Float64Array( [] ); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, 0, 1, 0 ), correction ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a correction argument yielding `N-correction` less than or equal to `0`, the function returns `NaN`', function test( t ) { + var correction; + var opts; + var x; + var v; + + opts = { + 'dtype': 'float64' + }; + + x = new Float64Array( [ 1.0 ] ); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, 1, 1, 0 ), correction ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var correction; + var expected; + var opts; + var x; + var v; + + opts = { + 'dtype': 'float64' + }; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, 4, 2, 0 ), correction ] ); + expected = 1.25; + if ( abs( v - expected ) < 5.0*EPS ) { + t.ok( true, 'returns expected value' ); + } else { + t.strictEqual( v, expected, 'returns expected value' ); + } + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var correction; + var expected; + var opts; + var x; + var v; + + opts = { + 'dtype': 'float64' + }; + + x = new Float64Array([ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, 4, -2, 6 ), correction ] ); + expected = 1.25; + if ( abs( v - expected ) < 5.0*EPS ) { + t.ok( true, 'returns expected value' ); + } else { + t.strictEqual( v, expected, 'returns expected value' ); + } + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var correction; + var expected; + var opts; + var x; + var v; + + opts = { + 'dtype': 'float64' + }; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]); + correction = scalar2ndarray( 1.0, opts ); + + v = dsem( [ vector( x, 4, 2, 1 ), correction ] ); + expected = 1.25; + if ( abs( v - expected ) < 5.0*EPS ) { + t.ok( true, 'returns expected value' ); + } else { + t.strictEqual( v, expected, 'returns expected value' ); + } + + t.end(); +}); From 459e06cc968767095861249eaa7ec49f223e70d7 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 3 Jan 2026 19:42:01 +0000 Subject: [PATCH 2/2] chore: update copyright years --- lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md | 2 +- .../@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js | 2 +- .../@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts | 2 +- .../@stdlib/stats/base/ndarray/dsem/docs/types/test.ts | 2 +- .../@stdlib/stats/base/ndarray/dsem/examples/index.js | 2 +- lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js | 2 +- lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js | 2 +- lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md index 8e023c7b8edc..34a4075721f8 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js index 7bf8bcaabd62..b5f7095d86f5 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts index 2be977107160..e006c4abf355 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/test.ts index a13bff73db47..fe54f55aae2f 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/examples/index.js index e758b9e73877..18bbd6238be3 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js index 872074a79085..6155a9f34aac 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js index 915687b6b052..18447dd964f5 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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/dsem/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js index 76d0fd32cce7..e188f7e506a2 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dsem/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dsem/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.