Skip to content

Commit 14f3f1a

Browse files
authored
feat!: update namespace TypeScript declarations
The `dcuminabs` API has moved to `stats/strided/dcuminabs`. BREAKING CHANGE: remove `dcuminabs` To migrate, users should access `dcuminabs` in the `stats/strided/*` namespace.
1 parent cbf1382 commit 14f3f1a

File tree

3 files changed

+7
-78
lines changed

3 files changed

+7
-78
lines changed

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

Lines changed: 5 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -127,44 +127,24 @@ interface Namespace {
127127
* @example
128128
* var Complex64Array = require( '@stdlib/array/complex64' );
129129
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
130-
* var realf = require( '@stdlib/complex/float32/real' );
131-
* var imagf = require( '@stdlib/complex/float32/imag' );
132130
*
133131
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
134132
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
135133
* var ca = new Complex64( 2.0, 2.0 );
136134
*
137135
* ns.caxpy( 2, ca, cx, 2, cy, 2 );
138-
*
139-
* var z = cy.get( 0 );
140-
* // returns <Complex64>
141-
*
142-
* var re = realf( z );
143-
* // returns -1.0
144-
*
145-
* var im = imagf( z );
146-
* // returns 7.0
136+
* // cy => <Complex64Array>[ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ]
147137
*
148138
* @example
149139
* var Complex64Array = require( '@stdlib/array/complex64' );
150140
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
151-
* var realf = require( '@stdlib/complex/float32/real' );
152-
* var imagf = require( '@stdlib/complex/float32/imag' );
153141
*
154142
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
155143
* var cy = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
156144
* var ca = new Complex64( 2.0, 2.0 );
157145
*
158146
* ns.caxpy.ndarray( 3, ca, cx, 1, 1, cy, 1, 1 );
159-
*
160-
* var z = cy.get( 3 );
161-
* // returns <Complex64>
162-
*
163-
* var re = realf( z );
164-
* // returns -1.0
165-
*
166-
* var im = imagf( z );
167-
* // returns 31.0
147+
* // cy => <Complex64Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ]
168148
*/
169149
caxpy: typeof caxpy;
170150

@@ -210,42 +190,22 @@ interface Namespace {
210190
* @example
211191
* var Complex64Array = require( '@stdlib/array/complex64' );
212192
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
213-
* var realf = require( '@stdlib/complex/float32/real' );
214-
* var imagf = require( '@stdlib/complex/float32/imag' );
215193
*
216194
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
217195
* var ca = new Complex64( 2.0, 2.0 );
218196
*
219197
* ns.cscal( 3, ca, cx, 1 );
220-
*
221-
* var z = cx.get( 0 );
222-
* // returns <Complex64>
223-
*
224-
* var re = realf( z );
225-
* // returns -2.0
226-
*
227-
* var im = imagf( z );
228-
* // returns 6.0
198+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
229199
*
230200
* @example
231201
* var Complex64Array = require( '@stdlib/array/complex64' );
232202
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
233-
* var realf = require( '@stdlib/complex/float32/real' );
234-
* var imagf = require( '@stdlib/complex/float32/imag' );
235203
*
236204
* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
237205
* var ca = new Complex64( 2.0, 2.0 );
238206
*
239-
* ns.cscal.ndarray( 2, ca, cx, 1, 0 );
240-
*
241-
* var z = cx.get( 0 );
242-
* // returns <Complex64>
243-
*
244-
* var re = realf( z );
245-
* // returns -2.0
246-
*
247-
* var im = imagf( z );
248-
* // returns 6.0
207+
* ns.cscal.ndarray( 3, ca, cx, 1, 0 );
208+
* // cx => <Complex64Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
249209
*/
250210
cscal: typeof cscal;
251211

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2147,7 +2147,7 @@ interface Namespace {
21472147
*
21482148
* @param N - number of indexed elements
21492149
* @param x - input array
2150-
* @param stride - stride length
2150+
* @param strideX - stride length
21512151
* @returns sum
21522152
*
21532153
* @example

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

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ import cumaxabs = require( '@stdlib/stats/base/cumaxabs' );
2525
import cumin = require( '@stdlib/stats/base/cumin' );
2626
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
2727
import dcumin = require( '@stdlib/stats/base/dcumin' );
28-
import dcuminabs = require( '@stdlib/stats/strided/dcuminabs' );
2928
import dists = require( '@stdlib/stats/base/dists' );
3029
import dmaxabs = require( '@stdlib/stats/base/dmaxabs' );
3130
import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' );
@@ -374,36 +373,6 @@ interface Namespace {
374373
*/
375374
dcumin: typeof dcumin;
376375

377-
/**
378-
* Computes the cumulative minimum absolute value of double-precision floating-point strided array elements.
379-
*
380-
* @param N - number of indexed elements
381-
* @param x - input array
382-
* @param strideX - `x` stride length
383-
* @param y - output array
384-
* @param strideY - `y` stride length
385-
* @returns output array
386-
*
387-
* @example
388-
* var Float64Array = require( '@stdlib/array/float64' );
389-
*
390-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
391-
* var y = new Float64Array( x.length );
392-
*
393-
* ns.dcuminabs( x.length, x, 1, y, 1 );
394-
* // y => <Float64Array>[ 1.0, 1.0, 1.0 ]
395-
*
396-
* @example
397-
* var Float64Array = require( '@stdlib/array/float64' );
398-
*
399-
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
400-
* var y = new Float64Array( x.length );
401-
*
402-
* ns.dcuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );
403-
* // y => <Float64Array>[ 1.0, 1.0, 1.0 ]
404-
*/
405-
dcuminabs: typeof dcuminabs;
406-
407376
/**
408377
* Base (i.e., lower-level) probability distributions.
409378
*/
@@ -5474,7 +5443,7 @@ interface Namespace {
54745443
* @param N - number of indexed elements
54755444
* @param correction - degrees of freedom adjustment
54765445
* @param x - input array
5477-
* @param stride - stride length
5446+
* @param strideX - stride length
54785447
* @returns standard deviation
54795448
*
54805449
* @example

0 commit comments

Comments
 (0)