Skip to content

Commit a65d18d

Browse files
authored
feat: update stats/base/ndarray TypeScript declarations
PR-URL: #9966 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 5ad3041 commit a65d18d

File tree

1 file changed

+56
-0
lines changed
  • lib/node_modules/@stdlib/stats/base/ndarray/docs/types

1 file changed

+56
-0
lines changed

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ import dnanmskmin = require( '@stdlib/stats/base/ndarray/dnanmskmin' );
6565
import dnanmskrange = require( '@stdlib/stats/base/ndarray/dnanmskrange' );
6666
import dnanrange = require( '@stdlib/stats/base/ndarray/dnanrange' );
6767
import drange = require( '@stdlib/stats/base/ndarray/drange' );
68+
import drangeabs = require( '@stdlib/stats/base/ndarray/drangeabs' );
6869
import dstdev = require( '@stdlib/stats/base/ndarray/dstdev' );
6970
import dstdevch = require( '@stdlib/stats/base/ndarray/dstdevch' );
7071
import dstdevpn = require( '@stdlib/stats/base/ndarray/dstdevpn' );
@@ -112,6 +113,7 @@ import nanrange = require( '@stdlib/stats/base/ndarray/nanrange' );
112113
import nanrangeBy = require( '@stdlib/stats/base/ndarray/nanrange-by' );
113114
import range = require( '@stdlib/stats/base/ndarray/range' );
114115
import rangeBy = require( '@stdlib/stats/base/ndarray/range-by' );
116+
import rangeabs = require( '@stdlib/stats/base/ndarray/rangeabs' );
115117
import scovarmtk = require( '@stdlib/stats/base/ndarray/scovarmtk' );
116118
import scumax = require( '@stdlib/stats/base/ndarray/scumax' );
117119
import scumaxabs = require( '@stdlib/stats/base/ndarray/scumaxabs' );
@@ -156,6 +158,7 @@ import snanmskmin = require( '@stdlib/stats/base/ndarray/snanmskmin' );
156158
import snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange' );
157159
import snanrange = require( '@stdlib/stats/base/ndarray/snanrange' );
158160
import srange = require( '@stdlib/stats/base/ndarray/srange' );
161+
import srangeabs = require( '@stdlib/stats/base/ndarray/srangeabs' );
159162
import sstdev = require( '@stdlib/stats/base/ndarray/sstdev' );
160163
import sstdevch = require( '@stdlib/stats/base/ndarray/sstdevch' );
161164
import sstdevpn = require( '@stdlib/stats/base/ndarray/sstdevpn' );
@@ -1122,6 +1125,24 @@ interface Namespace {
11221125
*/
11231126
drange: typeof drange;
11241127

1128+
/**
1129+
* Computes the range of absolute values of a one-dimensional double-precision floating-point ndarray.
1130+
*
1131+
* @param arrays - array-like object containing an input ndarray
1132+
* @returns range
1133+
*
1134+
* @example
1135+
* var Float64Array = require( '@stdlib/array/float64' );
1136+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
1137+
*
1138+
* var xbuf = new Float64Array( [ 1.0, -3.0, 4.0, 2.0 ] );
1139+
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
1140+
*
1141+
* var v = ns.drangeabs( [ x ] );
1142+
* // returns 3.0
1143+
*/
1144+
drangeabs: typeof drangeabs;
1145+
11251146
/**
11261147
* Computes the standard deviation of a one-dimensional double-precision floating-point ndarray.
11271148
*
@@ -2108,6 +2129,23 @@ interface Namespace {
21082129
*/
21092130
rangeBy: typeof rangeBy;
21102131

2132+
/**
2133+
* Computes the range of absolute values of a one-dimensional ndarray.
2134+
*
2135+
* @param arrays - array-like object containing an input ndarray
2136+
* @returns range
2137+
*
2138+
* @example
2139+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
2140+
*
2141+
* var xbuf = [ 1.0, -3.0, 4.0, 2.0 ];
2142+
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
2143+
*
2144+
* var v = ns.rangeabs( [ x ] );
2145+
* // returns 3.0
2146+
*/
2147+
rangeabs: typeof rangeabs;
2148+
21112149
/**
21122150
* Computes the covariance of two one-dimensional single-precision floating-point ndarrays provided known means and using a one-pass textbook algorithm.
21132151
*
@@ -2990,6 +3028,24 @@ interface Namespace {
29903028
*/
29913029
srange: typeof srange;
29923030

3031+
/**
3032+
* Computes the range of absolute values of a one-dimensional single-precision floating-point ndarray.
3033+
*
3034+
* @param arrays - array-like object containing an input ndarray
3035+
* @returns range
3036+
*
3037+
* @example
3038+
* var Float32Array = require( '@stdlib/array/float32' );
3039+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3040+
*
3041+
* var xbuf = new Float32Array( [ 1.0, -3.0, 4.0, 2.0 ] );
3042+
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
3043+
*
3044+
* var v = ns.srangeabs( [ x ] );
3045+
* // returns 3.0
3046+
*/
3047+
srangeabs: typeof srangeabs;
3048+
29933049
/**
29943050
* Computes the standard deviation of a one-dimensional ndarray.
29953051
*

0 commit comments

Comments
 (0)