Skip to content

Commit 71f4422

Browse files
authored
feat: update stats/strided TypeScript declarations
PR-URL: stdlib-js#9985 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 18a1271 commit 71f4422

File tree

1 file changed

+33
-0
lines changed
  • lib/node_modules/@stdlib/stats/strided/docs/types

1 file changed

+33
-0
lines changed

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ import dmin = require( '@stdlib/stats/strided/dmin' );
5151
import dminabs = require( '@stdlib/stats/strided/dminabs' );
5252
import dminsorted = require( '@stdlib/stats/strided/dminsorted' );
5353
import dmskmax = require( '@stdlib/stats/strided/dmskmax' );
54+
import dmskmaxabs = require( '@stdlib/stats/strided/dmskmaxabs' );
5455
import dmskmidrange = require( '@stdlib/stats/strided/dmskmidrange' );
5556
import dmskmin = require( '@stdlib/stats/strided/dmskmin' );
5657
import dmskrange = require( '@stdlib/stats/strided/dmskrange' );
@@ -1141,6 +1142,38 @@ interface Namespace {
11411142
*/
11421143
dmskmax: typeof dmskmax;
11431144

1145+
/**
1146+
* Computes the maximum absolute value of a double-precision floating-point strided array according to a mask.
1147+
*
1148+
* @param N - number of indexed elements
1149+
* @param x - input array
1150+
* @param strideX - `x` stride length
1151+
* @param mask - mask array
1152+
* @param strideMask - `mask` stride length
1153+
* @returns maximum absolute value
1154+
*
1155+
* @example
1156+
* var Float64Array = require( '@stdlib/array/float64' );
1157+
* var Uint8Array = require( '@stdlib/array/uint8' );
1158+
*
1159+
* var x = new Float64Array( [ 1.0, -2.0, 4.0, 2.0 ] );
1160+
* var mask = new Uint8Array( [ 0, 0, 1, 0 ] );
1161+
*
1162+
* var v = ns.dmskmaxabs( x.length, x, 1, mask, 1 );
1163+
* // returns 2.0
1164+
*
1165+
* @example
1166+
* var Float64Array = require( '@stdlib/array/float64' );
1167+
* var Uint8Array = require( '@stdlib/array/uint8' );
1168+
*
1169+
* var x = new Float64Array( [ 1.0, -2.0, 4.0, 2.0 ] );
1170+
* var mask = new Uint8Array( [ 0, 0, 1, 0 ] );
1171+
*
1172+
* var v = ns.dmskmaxabs.ndarray( x.length, x, 1, 0, mask, 1, 0 );
1173+
* // returns 2.0
1174+
*/
1175+
dmskmaxabs: typeof dmskmaxabs;
1176+
11441177
/**
11451178
* Computes the mid-range of a double-precision floating-point strided array according to a mask.
11461179
*

0 commit comments

Comments
 (0)