Skip to content

Commit cef8ee6

Browse files
authored
feat: update stats/base/ndarray TypeScript declarations
PR-URL: #10001 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent d660cab commit cef8ee6

1 file changed

Lines changed: 100 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/stats/base/ndarray/docs/types

lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ import drangeabs = require( '@stdlib/stats/base/ndarray/drangeabs' );
6969
import dstdev = require( '@stdlib/stats/base/ndarray/dstdev' );
7070
import dstdevch = require( '@stdlib/stats/base/ndarray/dstdevch' );
7171
import dstdevpn = require( '@stdlib/stats/base/ndarray/dstdevpn' );
72+
import dstdevtk = require( '@stdlib/stats/base/ndarray/dstdevtk' );
7273
import dstdevwd = require( '@stdlib/stats/base/ndarray/dstdevwd' );
74+
import dstdevyc = require( '@stdlib/stats/base/ndarray/dstdevyc' );
7375
import dztest = require( '@stdlib/stats/base/ndarray/dztest' );
7476
import dztest2 = require( '@stdlib/stats/base/ndarray/dztest2' );
7577
import max = require( '@stdlib/stats/base/ndarray/max' );
@@ -164,7 +166,9 @@ import srangeabs = require( '@stdlib/stats/base/ndarray/srangeabs' );
164166
import sstdev = require( '@stdlib/stats/base/ndarray/sstdev' );
165167
import sstdevch = require( '@stdlib/stats/base/ndarray/sstdevch' );
166168
import sstdevpn = require( '@stdlib/stats/base/ndarray/sstdevpn' );
169+
import sstdevtk = require( '@stdlib/stats/base/ndarray/sstdevtk' );
167170
import sstdevwd = require( '@stdlib/stats/base/ndarray/sstdevwd' );
171+
import sstdevyc = require( '@stdlib/stats/base/ndarray/sstdevyc' );
168172
import stdev = require( '@stdlib/stats/base/ndarray/stdev' );
169173
import stdevch = require( '@stdlib/stats/base/ndarray/stdevch' );
170174
import stdevpn = require( '@stdlib/stats/base/ndarray/stdevpn' );
@@ -1217,6 +1221,30 @@ interface Namespace {
12171221
*/
12181222
dstdevpn: typeof dstdevpn;
12191223

1224+
/**
1225+
* Computes the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass textbook algorithm.
1226+
*
1227+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
1228+
* @returns standard deviation
1229+
*
1230+
* @example
1231+
* var ndarray = require( '@stdlib/ndarray/ctor' );
1232+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
1233+
* var Float64Array = require( '@stdlib/array/float64' );
1234+
*
1235+
* var opts = {
1236+
* 'dtype': 'float64'
1237+
* };
1238+
*
1239+
* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] );
1240+
* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
1241+
* var correction = scalar2ndarray( 1.0, opts );
1242+
*
1243+
* var v = ns.dstdevtk( [ x, correction ] );
1244+
* // returns ~2.0817
1245+
*/
1246+
dstdevtk: typeof dstdevtk;
1247+
12201248
/**
12211249
* Computes the standard deviation of a one-dimensional double-precision floating-point ndarray using Welford's algorithm.
12221250
*
@@ -1241,6 +1269,30 @@ interface Namespace {
12411269
*/
12421270
dstdevwd: typeof dstdevwd;
12431271

1272+
/**
1273+
* Computes the standard deviation of a one-dimensional double-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer.
1274+
*
1275+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
1276+
* @returns standard deviation
1277+
*
1278+
* @example
1279+
* var ndarray = require( '@stdlib/ndarray/ctor' );
1280+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
1281+
* var Float64Array = require( '@stdlib/array/float64' );
1282+
*
1283+
* var opts = {
1284+
* 'dtype': 'float64'
1285+
* };
1286+
*
1287+
* var xbuf = new Float64Array( [ 1.0, -2.0, 2.0 ] );
1288+
* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
1289+
* var correction = scalar2ndarray( 1.0, opts );
1290+
*
1291+
* var v = ns.dstdevyc( [ x, correction ] );
1292+
* // returns ~2.0817
1293+
*/
1294+
dstdevyc: typeof dstdevyc;
1295+
12441296
/**
12451297
* Computes a one-sample Z-test for a one-dimensional double-precision floating-point ndarray.
12461298
*
@@ -3162,6 +3214,30 @@ interface Namespace {
31623214
*/
31633215
sstdevpn: typeof sstdevpn;
31643216

3217+
/**
3218+
* Computes the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass textbook algorithm.
3219+
*
3220+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
3221+
* @returns standard deviation
3222+
*
3223+
* @example
3224+
* var ndarray = require( '@stdlib/ndarray/ctor' );
3225+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3226+
* var Float32Array = require( '@stdlib/array/float32' );
3227+
*
3228+
* var opts = {
3229+
* 'dtype': 'float32'
3230+
* };
3231+
*
3232+
* var xbuf = new Float32Array( [ 1.0, -2.0, 2.0 ] );
3233+
* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
3234+
* var correction = scalar2ndarray( 1.0, opts );
3235+
*
3236+
* var v = ns.sstdevtk( [ x, correction ] );
3237+
* // returns ~2.0817
3238+
*/
3239+
sstdevtk: typeof sstdevtk;
3240+
31653241
/**
31663242
* Computes the standard deviation of a one-dimensional single-precision floating-point ndarray using Welford's algorithm.
31673243
*
@@ -3186,6 +3262,30 @@ interface Namespace {
31863262
*/
31873263
sstdevwd: typeof sstdevwd;
31883264

3265+
/**
3266+
* Computes the standard deviation of a one-dimensional single-precision floating-point ndarray using a one-pass algorithm proposed by Youngs and Cramer.
3267+
*
3268+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying a degrees of freedom adjustment
3269+
* @returns standard deviation
3270+
*
3271+
* @example
3272+
* var ndarray = require( '@stdlib/ndarray/ctor' );
3273+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3274+
* var Float32Array = require( '@stdlib/array/float32' );
3275+
*
3276+
* var opts = {
3277+
* 'dtype': 'float32'
3278+
* };
3279+
*
3280+
* var xbuf = new Float32Array( [ 1.0, -2.0, 2.0 ] );
3281+
* var x = new ndarray( opts.dtype, xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
3282+
* var correction = scalar2ndarray( 1.0, opts );
3283+
*
3284+
* var v = ns.sstdevyc( [ x, correction ] );
3285+
* // returns ~2.0817
3286+
*/
3287+
sstdevyc: typeof sstdevyc;
3288+
31893289
/**
31903290
* Computes the standard deviation of a one-dimensional ndarray.
31913291
*

0 commit comments

Comments
 (0)