From 0e236ad72b047d0c1b9ed64ca71bd93eae41e9f0 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sat, 31 Jan 2026 03:48:51 +0000 Subject: [PATCH] feat: update `stats/base/ndarray` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../stats/base/ndarray/docs/types/index.d.ts | 100 ++++++++++++++++++ 1 file changed, 100 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts index 892041e094b9..90e116afbcb4 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts @@ -69,7 +69,9 @@ import drangeabs = require( '@stdlib/stats/base/ndarray/drangeabs' ); import dstdev = require( '@stdlib/stats/base/ndarray/dstdev' ); import dstdevch = require( '@stdlib/stats/base/ndarray/dstdevch' ); import dstdevpn = require( '@stdlib/stats/base/ndarray/dstdevpn' ); +import dstdevtk = require( '@stdlib/stats/base/ndarray/dstdevtk' ); import dstdevwd = require( '@stdlib/stats/base/ndarray/dstdevwd' ); +import dstdevyc = require( '@stdlib/stats/base/ndarray/dstdevyc' ); import dztest = require( '@stdlib/stats/base/ndarray/dztest' ); import dztest2 = require( '@stdlib/stats/base/ndarray/dztest2' ); import max = require( '@stdlib/stats/base/ndarray/max' ); @@ -164,7 +166,9 @@ import srangeabs = require( '@stdlib/stats/base/ndarray/srangeabs' ); import sstdev = require( '@stdlib/stats/base/ndarray/sstdev' ); import sstdevch = require( '@stdlib/stats/base/ndarray/sstdevch' ); import sstdevpn = require( '@stdlib/stats/base/ndarray/sstdevpn' ); +import sstdevtk = require( '@stdlib/stats/base/ndarray/sstdevtk' ); import sstdevwd = require( '@stdlib/stats/base/ndarray/sstdevwd' ); +import sstdevyc = require( '@stdlib/stats/base/ndarray/sstdevyc' ); import stdev = require( '@stdlib/stats/base/ndarray/stdev' ); import stdevch = require( '@stdlib/stats/base/ndarray/stdevch' ); import stdevpn = require( '@stdlib/stats/base/ndarray/stdevpn' ); @@ -1217,6 +1221,30 @@ interface Namespace { */ dstdevpn: typeof dstdevpn; + /** + * Computes the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass textbook algorithm. + * + * @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment + * @returns standard deviation + * + * @example + * var ndarray = require( '@stdlib/ndarray/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 = ns.dstdevtk( [ x, correction ] ); + * // returns ~2.0817 + */ + dstdevtk: typeof dstdevtk; + /** * Computes the standard deviation of a one-dimensional double-precision floating-point ndarray using Welford's algorithm. * @@ -1241,6 +1269,30 @@ interface Namespace { */ dstdevwd: typeof dstdevwd; + /** + * Computes the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer. + * + * @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment + * @returns standard deviation + * + * @example + * var ndarray = require( '@stdlib/ndarray/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 = ns.dstdevyc( [ x, correction ] ); + * // returns ~2.0817 + */ + dstdevyc: typeof dstdevyc; + /** * Computes a one-sample Z-test for a one-dimensional double-precision floating-point ndarray. * @@ -3162,6 +3214,30 @@ interface Namespace { */ sstdevpn: typeof sstdevpn; + /** + * Computes the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass textbook algorithm. + * + * @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment + * @returns standard deviation + * + * @example + * var ndarray = require( '@stdlib/ndarray/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var opts = { + * 'dtype': 'float32' + * }; + * + * var xbuf = new Float32Array( [ 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 = ns.sstdevtk( [ x, correction ] ); + * // returns ~2.0817 + */ + sstdevtk: typeof sstdevtk; + /** * Computes the standard deviation of a one-dimensional single-precision floating-point ndarray using Welford's algorithm. * @@ -3186,6 +3262,30 @@ interface Namespace { */ sstdevwd: typeof sstdevwd; + /** + * Computes the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer. + * + * @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment + * @returns standard deviation + * + * @example + * var ndarray = require( '@stdlib/ndarray/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var opts = { + * 'dtype': 'float32' + * }; + * + * var xbuf = new Float32Array( [ 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 = ns.sstdevyc( [ x, correction ] ); + * // returns ~2.0817 + */ + sstdevyc: typeof sstdevyc; + /** * Computes the standard deviation of a one-dimensional ndarray. *