Skip to content

Commit ae8e7b9

Browse files
authored
feat!: update namespace TypeScript declarations
This commit removes the `dmaxabs` symbol from the `stats/base` namespace as the corresponding package has been migrated to `stats/strided` BREAKING CHANGE: remove `dmaxabs` To migrate, users should access `dmaxabs` via the `stats/strided` namespace. PR-URL: #5254 Reviewed-by: Athan Reines <[email protected]>
1 parent b090b90 commit ae8e7b9

File tree

4 files changed

+49
-38
lines changed

4 files changed

+49
-38
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2126,30 +2126,30 @@ interface Namespace {
21262126
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant.
21272127
*
21282128
* @param N - number of indexed elements
2129-
* @param za - scalar constant
2130-
* @param zx - input array
2131-
* @param strideX - `zx` stride length
2129+
* @param alpha - scalar constant
2130+
* @param x - input array
2131+
* @param strideX - `x` stride length
21322132
* @returns input array
21332133
*
21342134
* @example
21352135
* var Complex128Array = require( '@stdlib/array/complex128' );
21362136
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
21372137
*
2138-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2139-
* var za = new Complex128( 2.0, 2.0 );
2138+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2139+
* var alpha = new Complex128( 2.0, 2.0 );
21402140
*
2141-
* ns.zscal( 3, za, zx, 1 );
2142-
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
2141+
* ns.zscal( 3, alpha, x, 1 );
2142+
* // x => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
21432143
*
21442144
* @example
21452145
* var Complex128Array = require( '@stdlib/array/complex128' );
21462146
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
21472147
*
2148-
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2149-
* var za = new Complex128( 2.0, 2.0 );
2148+
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2149+
* var alpha = new Complex128( 2.0, 2.0 );
21502150
*
2151-
* ns.zscal.ndarray( 2, za, zx, 1, 1 );
2152-
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
2151+
* ns.zscal.ndarray( 2, alpha, x, 1, 1 );
2152+
* // x => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
21532153
*/
21542154
zscal: typeof zscal;
21552155

lib/node_modules/@stdlib/complex/float32/base/docs/types/index.d.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,25 @@ interface Namespace {
8585
*
8686
* var im = imagf( out );
8787
* // returns -1.0
88+
*
89+
* @example
90+
* var Float32Array = require( '@stdlib/array/float32' );
91+
*
92+
* var out = new Float32Array( 2 );
93+
* var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
94+
* // returns <Float32Array>[ -13.0, -1.0 ]
95+
*
96+
* var bool = ( out === v );
97+
* // returns true
98+
*
99+
* @example
100+
* var Float32Array = require( '@stdlib/array/float32' );
101+
*
102+
* var z1 = new Float32Array( [ 5.0, 3.0 ] );
103+
* var z2 = new Float32Array( [ -2.0, 1.0 ] );
104+
*
105+
* var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 );
106+
* // returns <Float32Array>[ -13.0, -1.0 ]
88107
*/
89108
mul: typeof mul;
90109
}

lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,25 @@ interface Namespace {
9797
*
9898
* var im = imagf( out );
9999
* // returns -1.0
100+
*
101+
* @example
102+
* var Float32Array = require( '@stdlib/array/float32' );
103+
*
104+
* var out = new Float32Array( 2 );
105+
* var v = ns.cmulf.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
106+
* // returns <Float32Array>[ -13.0, -1.0 ]
107+
*
108+
* var bool = ( out === v );
109+
* // returns true
110+
*
111+
* @example
112+
* var Float32Array = require( '@stdlib/array/float32' );
113+
*
114+
* var z1 = new Float32Array( [ 5.0, 3.0 ] );
115+
* var z2 = new Float32Array( [ -2.0, 1.0 ] );
116+
*
117+
* var out = ns.cmulf.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 );
118+
* // returns <Float32Array>[ -13.0, -1.0 ]
100119
*/
101120
cmulf: typeof cmulf;
102121

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

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ import cumin = require( '@stdlib/stats/base/cumin' );
2626
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
2727
import dcumin = require( '@stdlib/stats/base/dcumin' );
2828
import dists = require( '@stdlib/stats/base/dists' );
29-
import dmaxabs = require( '@stdlib/stats/strided/dmaxabs' );
3029
import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' );
3130
import dmaxsorted = require( '@stdlib/stats/base/dmaxsorted' );
3231
import dmean = require( '@stdlib/stats/base/dmean' );
@@ -378,32 +377,6 @@ interface Namespace {
378377
*/
379378
dists: typeof dists;
380379

381-
/**
382-
* Computes the maximum absolute value of a double-precision floating-point strided array.
383-
*
384-
* @param N - number of indexed elements
385-
* @param x - input array
386-
* @param strideX - stride length
387-
* @returns maximum absolute value
388-
*
389-
* @example
390-
* var Float64Array = require( '@stdlib/array/float64' );
391-
*
392-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
393-
*
394-
* var v = ns.dmaxabs( x.length, x, 1 );
395-
* // returns 2.0
396-
*
397-
* @example
398-
* var Float64Array = require( '@stdlib/array/float64' );
399-
*
400-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
401-
*
402-
* var v = ns.dmaxabs.ndarray( x.length, x, 1, 0 );
403-
* // returns 2.0
404-
*/
405-
dmaxabs: typeof dmaxabs;
406-
407380
/**
408381
* Computes the maximum absolute value of a sorted double-precision floating-point strided array.
409382
*

0 commit comments

Comments
 (0)