Skip to content

feat: update stats/base/ndarray TypeScript declarations #9984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Jan 30, 2026
+44 −0
Merged

feat: update stats/base/ndarray TypeScript declarations #9984

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions lib/node_modules/@stdlib/stats/base/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ import minBy = require( '@stdlib/stats/base/ndarray/min-by' );
import minabs = require( '@stdlib/stats/base/ndarray/minabs' );
import minsorted = require( '@stdlib/stats/base/ndarray/minsorted' );
import mskmax = require( '@stdlib/stats/base/ndarray/mskmax' );
import mskmaxabs = require( '@stdlib/stats/base/ndarray/mskmaxabs' );
import mskmidrange = require( '@stdlib/stats/base/ndarray/mskmidrange' );
import mskmin = require( '@stdlib/stats/base/ndarray/mskmin' );
import mskrange = require( '@stdlib/stats/base/ndarray/mskrange' );
Expand Down Expand Up @@ -141,6 +142,7 @@ import smin = require( '@stdlib/stats/base/ndarray/smin' );
import sminabs = require( '@stdlib/stats/base/ndarray/sminabs' );
import sminsorted = require( '@stdlib/stats/base/ndarray/sminsorted' );
import smskmax = require( '@stdlib/stats/base/ndarray/smskmax' );
import smskmaxabs = require( '@stdlib/stats/base/ndarray/smskmaxabs' );
import smskmidrange = require( '@stdlib/stats/base/ndarray/smskmidrange' );
import smskmin = require( '@stdlib/stats/base/ndarray/smskmin' );
import smskrange = require( '@stdlib/stats/base/ndarray/smskrange' );
Expand Down Expand Up @@ -1707,6 +1709,26 @@ interface Namespace {
*/
mskmax: typeof mskmax;

/**
* Calculates the maximum absolute value of a one-dimensional ndarray according to a mask.
*
* @param arrays - array-like object containing an input ndarray and a mask ndarray
* @returns maximum absolute value
*
* @example
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = [ 1.0, -5.0, 4.0, 2.0 ];
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var mbuf = [ 0, 0, 1, 0 ];
* var mask = new ndarray( 'generic', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var v = ns.mskmaxabs( [ x, mask ] );
* // returns 5.0
*/
mskmaxabs: typeof mskmaxabs;

/**
* Calculates the mid-range of a one-dimensional ndarray according to a mask.
*
Expand Down Expand Up @@ -2698,6 +2720,28 @@ interface Namespace {
*/
smskmax: typeof smskmax;

/**
* Computes the maximum absolute value of a one-dimensional single-precision floating-point ndarray according to a mask.
*
* @param arrays - array-like object containing an input ndarray and a mask ndarray
* @returns maximum absolute value
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var Uint8Array = require( '@stdlib/array/uint8' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Float32Array( [ 1.0, -5.0, 4.0, 2.0 ] );
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var mbuf = new Uint8Array( [ 0, 0, 1, 0 ] );
* var mask = new ndarray( 'uint8', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var v = ns.smskmaxabs( [ x, mask ] );
* // returns 5.0
*/
smskmaxabs: typeof smskmaxabs;

/**
* Calculates the mid-range of a one-dimensional single-precision floating-point ndarray according to a mask.
*
Expand Down
Loading