Skip to content

Commit d66db3f

Browse files
authored
feat!: update namespace TypeScript declarations
This commit removes `add`, `add3`, and `add4` symbols from `math/base/ops`. Those symbols have moved to `number/float64/base`. BREAKING CHANGE: remove `add`, `add3`, and `add4` To migrate, users should access those symbols in the `number/float64/base` namespace. PR-URL: #5130 Reviewed-by: Athan Reines <[email protected]>
1 parent 152dfd2 commit d66db3f

File tree

4 files changed

+15
-128
lines changed

4 files changed

+15
-128
lines changed

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

+4-24
Original file line numberDiff line numberDiff line change
@@ -2090,41 +2090,21 @@ interface Namespace {
20902090
*
20912091
* @example
20922092
* var Complex128Array = require( '@stdlib/array/complex128' );
2093-
* var real = require( '@stdlib/complex/float64/real' );
2094-
* var imag = require( '@stdlib/complex/float64/imag' );
20952093
*
20962094
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2097-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
2095+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
20982096
*
20992097
* ns.zcopy( x.length, x, 1, y, 1 );
2100-
*
2101-
* var z = y.get( 0 );
2102-
* // returns <Complex128>
2103-
*
2104-
* var re = real( z );
2105-
* // returns 1.0
2106-
*
2107-
* var im = imag( z );
2108-
* // returns 2.0
2098+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
21092099
*
21102100
* @example
21112101
* var Complex128Array = require( '@stdlib/array/complex128' );
2112-
* var real = require( '@stdlib/complex/float64/real' );
2113-
* var imag = require( '@stdlib/complex/float64/imag' );
21142102
*
21152103
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2116-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
2104+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
21172105
*
21182106
* ns.zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
2119-
*
2120-
* var z = y.get( 0 );
2121-
* // returns <Complex128>
2122-
*
2123-
* var re = real( z );
2124-
* // returns 1.0
2125-
*
2126-
* var im = imag( z );
2127-
* // returns 2.0
2107+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
21282108
*/
21292109
zcopy: typeof zcopy;
21302110

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -1968,9 +1968,9 @@ interface Namespace {
19681968
* @param N - number of indexed elements
19691969
* @param order - sort order
19701970
* @param x - first input array
1971-
* @param strideX - `x` stride length
1971+
* @param strideX - stride length for `x`
19721972
* @param y - second input array
1973-
* @param strideY - `y` stride length
1973+
* @param strideY - stride length for `x`
19741974
* @returns `x`
19751975
*
19761976
* @example
@@ -2005,9 +2005,9 @@ interface Namespace {
20052005
* @param N - number of indexed elements
20062006
* @param order - sort order
20072007
* @param x - first input array
2008-
* @param strideX - `x` stride length
2008+
* @param strideX - stride length for `x`
20092009
* @param y - second input array
2010-
* @param strideY - `y` stride length
2010+
* @param strideY - stride length for `y`
20112011
* @returns `x`
20122012
*
20132013
* @example
@@ -2042,9 +2042,9 @@ interface Namespace {
20422042
* @param N - number of indexed elements
20432043
* @param order - sort order
20442044
* @param x - first input array
2045-
* @param strideX - `x` stride length
2045+
* @param strideX - stride length for `x`
20462046
* @param y - second input array
2047-
* @param strideY - `y` stride length
2047+
* @param strideY - stride length for `y`
20482048
* @returns `x`
20492049
*
20502050
* @example
@@ -2079,7 +2079,7 @@ interface Namespace {
20792079
* @param N - number of indexed elements
20802080
* @param order - sort order
20812081
* @param x - input array
2082-
* @param stride - stride length
2082+
* @param strideX - stride length
20832083
* @returns `x`
20842084
*
20852085
* @example

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

-93
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ import caddf = require( '@stdlib/complex/float32/base/add' );
2424
import cmulf = require( '@stdlib/complex/float32/base/mul' );
2525
import cadd = require( '@stdlib/complex/float64/base/add' );
2626
import cmul = require( '@stdlib/complex/float64/base/mul' );
27-
import add = require( '@stdlib/number/float64/base/add' );
28-
import add3 = require( '@stdlib/number/float64/base/add3' );
29-
import add4 = require( '@stdlib/number/float64/base/add4' );
3027
import add5 = require( '@stdlib/math/base/ops/add5' );
3128
import addf = require( '@stdlib/math/base/ops/addf' );
3229
import cdiv = require( '@stdlib/math/base/ops/cdiv' );
@@ -197,96 +194,6 @@ interface Namespace {
197194
*/
198195
cmul: typeof cmul;
199196

200-
/**
201-
* Computes the sum of two double-precision floating-point numbers `x` and `y`.
202-
*
203-
* @param x - first input value
204-
* @param y - second input value
205-
* @returns sum
206-
*
207-
* @example
208-
* var v = ns.add( -1.0, 5.0 );
209-
* // returns 4.0
210-
*
211-
* @example
212-
* var v = ns.add( 2.0, 5.0 );
213-
* // returns 7.0
214-
*
215-
* @example
216-
* var v = ns.add( 0.0, 5.0 );
217-
* // returns 5.0
218-
*
219-
* @example
220-
* var v = ns.add( -0.0, 0.0 );
221-
* // returns 0.0
222-
*
223-
* @example
224-
* var v = ns.add( NaN, NaN );
225-
* // returns NaN
226-
*/
227-
add: typeof add;
228-
229-
/**
230-
* Computes the sum of three double-precision floating-point numbers.
231-
*
232-
* @param x - first input value
233-
* @param y - second input value
234-
* @param z - third input value
235-
* @returns sum
236-
*
237-
* @example
238-
* var v = ns.add3( -1.0, 5.0, 2.0 );
239-
* // returns 6.0
240-
*
241-
* @example
242-
* var v = ns.add3( 2.0, 5.0, 2.0 );
243-
* // returns 9.0
244-
*
245-
* @example
246-
* var v = ns.add3( 0.0, 5.0, 2.0 );
247-
* // returns 7.0
248-
*
249-
* @example
250-
* var v = ns.add3( -0.0, 0.0, -0.0 );
251-
* // returns 0.0
252-
*
253-
* @example
254-
* var v = ns.add3( NaN, NaN, NaN );
255-
* // returns NaN
256-
*/
257-
add3: typeof add3;
258-
259-
/**
260-
* Computes the sum of four double-precision floating-point numbers.
261-
*
262-
* @param x - first input value
263-
* @param y - second input value
264-
* @param z - third input value
265-
* @param w - fourth input value
266-
* @returns sum
267-
*
268-
* @example
269-
* var v = ns.add4( -1.0, 5.0, 2.0, -3.0 );
270-
* // returns 3.0
271-
*
272-
* @example
273-
* var v = ns.add4( 2.0, 5.0, 2.0, -3.0 );
274-
* // returns 6.0
275-
*
276-
* @example
277-
* var v = ns.add4( 0.0, 5.0, 2.0, -3.0 );
278-
* // returns 4.0
279-
*
280-
* @example
281-
* var v = ns.add4( -0.0, 0.0, -0.0, -0.0 );
282-
* // returns 0.0
283-
*
284-
* @example
285-
* var v = ns.add4( NaN, NaN, NaN, NaN );
286-
* // returns NaN
287-
*/
288-
add4: typeof add4;
289-
290197
/**
291198
* Computes the sum of five double-precision floating-point numbers.
292199
*

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -2121,7 +2121,7 @@ interface Namespace {
21212121
*
21222122
* @param N - number of indexed elements
21232123
* @param x - input array
2124-
* @param stride - stride length
2124+
* @param strideX - stride length
21252125
* @returns arithmetic mean
21262126
*
21272127
* @example
@@ -2674,7 +2674,7 @@ interface Namespace {
26742674
*
26752675
* @param N - number of indexed elements
26762676
* @param x - input array
2677-
* @param stride - stride length
2677+
* @param strideX - stride length
26782678
* @returns maximum absolute value
26792679
*
26802680
* @example
@@ -2959,7 +2959,7 @@ interface Namespace {
29592959
*
29602960
* @param N - number of indexed elements
29612961
* @param x - input array
2962-
* @param stride - stride length
2962+
* @param strideX - stride length
29632963
* @returns minimum absolute value
29642964
*
29652965
* @example
@@ -3959,7 +3959,7 @@ interface Namespace {
39593959
*
39603960
* @param N - number of indexed elements
39613961
* @param x - input array
3962-
* @param stride - stride length
3962+
* @param strideX - stride length
39633963
* @returns arithmetic mean
39643964
*
39653965
* @example

0 commit comments

Comments
 (0)