Skip to content

Commit 18a1271

Browse files
authored
feat: update stats/base/ndarray TypeScript declarations
PR-URL: #9984 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 221e7ef commit 18a1271

File tree

1 file changed

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

1 file changed

+44
-0
lines changed

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ import minBy = require( '@stdlib/stats/base/ndarray/min-by' );
9191
import minabs = require( '@stdlib/stats/base/ndarray/minabs' );
9292
import minsorted = require( '@stdlib/stats/base/ndarray/minsorted' );
9393
import mskmax = require( '@stdlib/stats/base/ndarray/mskmax' );
94+
import mskmaxabs = require( '@stdlib/stats/base/ndarray/mskmaxabs' );
9495
import mskmidrange = require( '@stdlib/stats/base/ndarray/mskmidrange' );
9596
import mskmin = require( '@stdlib/stats/base/ndarray/mskmin' );
9697
import mskrange = require( '@stdlib/stats/base/ndarray/mskrange' );
@@ -141,6 +142,7 @@ import smin = require( '@stdlib/stats/base/ndarray/smin' );
141142
import sminabs = require( '@stdlib/stats/base/ndarray/sminabs' );
142143
import sminsorted = require( '@stdlib/stats/base/ndarray/sminsorted' );
143144
import smskmax = require( '@stdlib/stats/base/ndarray/smskmax' );
145+
import smskmaxabs = require( '@stdlib/stats/base/ndarray/smskmaxabs' );
144146
import smskmidrange = require( '@stdlib/stats/base/ndarray/smskmidrange' );
145147
import smskmin = require( '@stdlib/stats/base/ndarray/smskmin' );
146148
import smskrange = require( '@stdlib/stats/base/ndarray/smskrange' );
@@ -1707,6 +1709,26 @@ interface Namespace {
17071709
*/
17081710
mskmax: typeof mskmax;
17091711

1712+
/**
1713+
* Calculates the maximum absolute value of a one-dimensional ndarray according to a mask.
1714+
*
1715+
* @param arrays - array-like object containing an input ndarray and a mask ndarray
1716+
* @returns maximum absolute value
1717+
*
1718+
* @example
1719+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
1720+
*
1721+
* var xbuf = [ 1.0, -5.0, 4.0, 2.0 ];
1722+
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
1723+
*
1724+
* var mbuf = [ 0, 0, 1, 0 ];
1725+
* var mask = new ndarray( 'generic', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
1726+
*
1727+
* var v = ns.mskmaxabs( [ x, mask ] );
1728+
* // returns 5.0
1729+
*/
1730+
mskmaxabs: typeof mskmaxabs;
1731+
17101732
/**
17111733
* Calculates the mid-range of a one-dimensional ndarray according to a mask.
17121734
*
@@ -2698,6 +2720,28 @@ interface Namespace {
26982720
*/
26992721
smskmax: typeof smskmax;
27002722

2723+
/**
2724+
* Computes the maximum absolute value of a one-dimensional single-precision floating-point ndarray according to a mask.
2725+
*
2726+
* @param arrays - array-like object containing an input ndarray and a mask ndarray
2727+
* @returns maximum absolute value
2728+
*
2729+
* @example
2730+
* var Float32Array = require( '@stdlib/array/float32' );
2731+
* var Uint8Array = require( '@stdlib/array/uint8' );
2732+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
2733+
*
2734+
* var xbuf = new Float32Array( [ 1.0, -5.0, 4.0, 2.0 ] );
2735+
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
2736+
*
2737+
* var mbuf = new Uint8Array( [ 0, 0, 1, 0 ] );
2738+
* var mask = new ndarray( 'uint8', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
2739+
*
2740+
* var v = ns.smskmaxabs( [ x, mask ] );
2741+
* // returns 5.0
2742+
*/
2743+
smskmaxabs: typeof smskmaxabs;
2744+
27012745
/**
27022746
* Calculates the mid-range of a one-dimensional single-precision floating-point ndarray according to a mask.
27032747
*

0 commit comments

Comments
 (0)