Skip to content

Commit 76cf95f

Browse files
stdlib-botstdlib-bot
authored
feat!: update namespace TypeScript declarations
This commit removes the `add5` symbol from the `math/base/ops` namespace. BREAKING CHANGE: remove `add5` To migrate, users should access the `add5` symbol via the `number/float64/base` namespace. PR-URL: #5243 Reviewed-by: Athan Reines <[email protected]>
1 parent 158bfde commit 76cf95f

File tree

3 files changed

+29
-174
lines changed

3 files changed

+29
-174
lines changed

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

Lines changed: 14 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -2037,44 +2037,24 @@ interface Namespace {
20372037
* @example
20382038
* var Complex128Array = require( '@stdlib/array/complex128' );
20392039
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2040-
* var real = require( '@stdlib/complex/float64/real' );
2041-
* var imag = require( '@stdlib/complex/float64/imag' );
20422040
*
20432041
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
20442042
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
20452043
* var za = new Complex128( 2.0, 2.0 );
20462044
*
20472045
* ns.zaxpy( 2, za, zx, 2, zy, 2 );
2048-
*
2049-
* var z = zy.get( 0 );
2050-
* // returns <Complex128>
2051-
*
2052-
* var re = real( z );
2053-
* // returns -1.0
2054-
*
2055-
* var im = imag( z );
2056-
* // returns 7.0
2046+
* // zy => <Complex128Array>[ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ]
20572047
*
20582048
* @example
20592049
* var Complex128Array = require( '@stdlib/array/complex128' );
20602050
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2061-
* var real = require( '@stdlib/complex/float64/real' );
2062-
* var imag = require( '@stdlib/complex/float64/imag' );
20632051
*
20642052
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
20652053
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
20662054
* var za = new Complex128( 2.0, 2.0 );
20672055
*
20682056
* ns.zaxpy.ndarray( 3, za, zx, 1, 1, zy, 1, 1 );
2069-
*
2070-
* var z = zy.get( 3 );
2071-
* // returns <Complex128>
2072-
*
2073-
* var re = real( z );
2074-
* // returns -1.0
2075-
*
2076-
* var im = imag( z );
2077-
* // returns 31.0
2057+
* // zy => <Complex128Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ]
20782058
*/
20792059
zaxpy: typeof zaxpy;
20802060

@@ -2122,59 +2102,23 @@ interface Namespace {
21222102
*
21232103
* @example
21242104
* var Complex128Array = require( '@stdlib/array/complex128' );
2125-
* var real = require( '@stdlib/complex/float64/real' );
2126-
* var imag = require( '@stdlib/complex/float64/imag' );
21272105
*
21282106
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
21292107
* var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
21302108
*
21312109
* ns.zdrot( 2, zx, 2, zy, 1, 0.8, 0.6 );
2132-
*
2133-
* var z = zy.get( 0 );
2134-
* // returns <Complex128>
2135-
*
2136-
* var re = real( z );
2137-
* // returns -0.6
2138-
*
2139-
* var im = imag( z );
2140-
* // returns -1.2
2141-
*
2142-
* z = zx.get( 0 );
2143-
* // returns <Complex128>
2144-
*
2145-
* re = real( z );
2146-
* // returns 0.8
2147-
*
2148-
* im = imag( z );
2149-
* // returns 1.6
2110+
* // zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
2111+
* // zy => <Complex128Array>[ ~-0.6, ~-1.2, -3.0, ~-3.6, 0.0, 0.0, 0.0, 0.0 ]
21502112
*
21512113
* @example
21522114
* var Complex128Array = require( '@stdlib/array/complex128' );
2153-
* var real = require( '@stdlib/complex/float64/real' );
2154-
* var imag = require( '@stdlib/complex/float64/imag' );
21552115
*
21562116
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
21572117
* var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
21582118
*
21592119
* ns.zdrot.ndarray( 2, zx, 2, 0, zy, 1, 0, 0.8, 0.6 );
2160-
*
2161-
* var z = zy.get( 0 );
2162-
* // returns <Complex128>
2163-
*
2164-
* var re = real( z );
2165-
* // returns -0.6
2166-
*
2167-
* var im = imag( z );
2168-
* // returns -1.2
2169-
*
2170-
* z = zx.get( 0 );
2171-
* // returns <Complex128>
2172-
*
2173-
* re = real( z );
2174-
* // returns 0.8
2175-
*
2176-
* im = imag( z );
2177-
* // returns 1.6
2120+
* // zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
2121+
* // zy => <Complex128Array>[ ~-0.6, ~-1.2, -3.0, ~-3.6, 0.0, 0.0, 0.0, 0.0 ]
21782122
*/
21792123
zdrot: typeof zdrot;
21802124

@@ -2190,42 +2134,22 @@ interface Namespace {
21902134
* @example
21912135
* var Complex128Array = require( '@stdlib/array/complex128' );
21922136
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2193-
* var real = require( '@stdlib/complex/float64/real' );
2194-
* var imag = require( '@stdlib/complex/float64/imag' );
21952137
*
21962138
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
21972139
* var za = new Complex128( 2.0, 2.0 );
21982140
*
21992141
* ns.zscal( 3, za, zx, 1 );
2200-
*
2201-
* var z = zx.get( 1 );
2202-
* // returns <Complex128>
2203-
*
2204-
* var re = real( z );
2205-
* // returns -2.0
2206-
*
2207-
* var im = imag( z );
2208-
* // returns 14.0
2142+
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
22092143
*
22102144
* @example
22112145
* var Complex128Array = require( '@stdlib/array/complex128' );
22122146
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
2213-
* var real = require( '@stdlib/complex/float64/real' );
2214-
* var imag = require( '@stdlib/complex/float64/imag' );
22152147
*
22162148
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
22172149
* var za = new Complex128( 2.0, 2.0 );
22182150
*
22192151
* ns.zscal.ndarray( 2, za, zx, 1, 1 );
2220-
*
2221-
* var z = zx.get( 1 );
2222-
* // returns <Complex128>
2223-
*
2224-
* var re = real( z );
2225-
* // returns -2.0
2226-
*
2227-
* var im = imag( z );
2228-
* // returns 14.0
2152+
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
22292153
*/
22302154
zscal: typeof zscal;
22312155

@@ -2241,59 +2165,23 @@ interface Namespace {
22412165
*
22422166
* @example
22432167
* var Complex128Array = require( '@stdlib/array/complex128' );
2244-
* var real = require( '@stdlib/complex/float64/real' );
2245-
* var imag = require( '@stdlib/complex/float64/imag' );
22462168
*
22472169
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2248-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
2170+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
22492171
*
22502172
* ns.zswap( x.length, x, 1, y, 1 );
2251-
*
2252-
* var z = y.get( 0 );
2253-
* // returns <Complex128>
2254-
*
2255-
* var re = real( z );
2256-
* // returns 1.0
2257-
*
2258-
* var im = imag( z );
2259-
* // returns 2.0
2260-
*
2261-
* z = x.get( 0 );
2262-
* // returns <Complex128>
2263-
*
2264-
* re = real( z );
2265-
* // returns 7.0
2266-
*
2267-
* im = imag( z );
2268-
* // returns 8.0
2173+
* // x => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
2174+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
22692175
*
22702176
* @example
22712177
* var Complex128Array = require( '@stdlib/array/complex128' );
2272-
* var real = require( '@stdlib/complex/float64/real' );
2273-
* var imag = require( '@stdlib/complex/float64/imag' );
22742178
*
22752179
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2276-
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
2180+
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
22772181
*
22782182
* ns.zswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
2279-
*
2280-
* var z = y.get( 0 );
2281-
* // returns <Complex128>
2282-
*
2283-
* var re = real( z );
2284-
* // returns 1.0
2285-
*
2286-
* var im = imag( z );
2287-
* // returns 2.0
2288-
*
2289-
* z = x.get( 0 );
2290-
* // returns <Complex128>
2291-
*
2292-
* re = real( z );
2293-
* // returns 7.0
2294-
*
2295-
* im = imag( z );
2296-
* // returns 8.0
2183+
* // x => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
2184+
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
22972185
*/
22982186
zswap: typeof zswap;
22992187
}

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -364,9 +364,9 @@ interface Namespace {
364364
* @param N - number of indexed elements
365365
* @param sum - initial sum
366366
* @param x - input array
367-
* @param strideX - `x` stride length
367+
* @param strideX - stride length for `x`
368368
* @param y - output array
369-
* @param strideY - `y` stride length
369+
* @param strideY - stride length for `y`
370370
* @returns output array
371371
*
372372
* @example
@@ -426,9 +426,9 @@ interface Namespace {
426426
* @param N - number of indexed elements
427427
* @param sum - initial sum
428428
* @param x - input array
429-
* @param strideX - `x` stride length
429+
* @param strideX - stride length for `x`
430430
* @param y - output array
431-
* @param strideY - `y` stride length
431+
* @param strideY - stride length for `y`
432432
* @returns output array
433433
*
434434
* @example
@@ -486,7 +486,7 @@ interface Namespace {
486486
* Fills a double-precision floating-point strided array with a specified scalar value.
487487
*
488488
* @param N - number of indexed elements
489-
* @param alpha - constant
489+
* @param alpha - scalar constant
490490
* @param x - input array
491491
* @param strideX - stride length
492492
* @returns input array
@@ -566,9 +566,9 @@ interface Namespace {
566566
*
567567
* @param N - number of indexed elements
568568
* @param x - input array
569-
* @param strideX - `x` stride length
569+
* @param strideX - stride length for `x`
570570
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
571-
* @param strideOut - `out` stride length
571+
* @param strideOut - stride length for `out`
572572
* @returns output array
573573
*
574574
* @example
@@ -596,9 +596,9 @@ interface Namespace {
596596
*
597597
* @param N - number of indexed elements
598598
* @param x - input array
599-
* @param strideX - `x` stride length
599+
* @param strideX - stride length for `x`
600600
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
601-
* @param strideOut - `out` stride length
601+
* @param strideOut - stride length for `out`
602602
* @returns output array
603603
*
604604
* @example
@@ -626,9 +626,9 @@ interface Namespace {
626626
*
627627
* @param N - number of indexed elements
628628
* @param x - input array
629-
* @param strideX - `x` stride length
629+
* @param strideX - stride length for `x`
630630
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
631-
* @param strideOut - `out` stride length
631+
* @param strideOut - stride length for `out`
632632
* @returns output array
633633
*
634634
* @example
@@ -656,9 +656,9 @@ interface Namespace {
656656
*
657657
* @param N - number of indexed elements
658658
* @param x - input array
659-
* @param strideX - `x` stride length
659+
* @param strideX - stride length for `x`
660660
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
661-
* @param strideOut - `out` stride length
661+
* @param strideOut - stride length for `out`
662662
* @returns output array
663663
*
664664
* @example
@@ -686,9 +686,9 @@ interface Namespace {
686686
*
687687
* @param N - number of indexed elements
688688
* @param x - input array
689-
* @param strideX - `x` stride length
689+
* @param strideX - stride length for `x`
690690
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
691-
* @param strideOut - `out` stride length
691+
* @param strideOut - stride length for `out`
692692
* @returns output array
693693
*
694694
* @example

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

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +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 add5 = require( '@stdlib/number/float64/base/add5' );
2827
import addf = require( '@stdlib/math/base/ops/addf' );
2928
import cdiv = require( '@stdlib/math/base/ops/cdiv' );
3029
import cneg = require( '@stdlib/math/base/ops/cneg' );
@@ -194,38 +193,6 @@ interface Namespace {
194193
*/
195194
cmul: typeof cmul;
196195

197-
/**
198-
* Computes the sum of five double-precision floating-point numbers.
199-
*
200-
* @param x - first input value
201-
* @param y - second input value
202-
* @param z - third input value
203-
* @param w - fourth input value
204-
* @param u - fifth input value
205-
* @returns sum
206-
*
207-
* @example
208-
* var v = ns.add5( -1.0, 5.0, 2.0, -3.0, 4.0 );
209-
* // returns 7.0
210-
*
211-
* @example
212-
* var v = ns.add5( 2.0, 5.0, 2.0, -3.0, 4.0 );
213-
* // returns 10.0
214-
*
215-
* @example
216-
* var v = ns.add5( 0.0, 5.0, 2.0, -3.0, 4.0 );
217-
* // returns 8.0
218-
*
219-
* @example
220-
* var v = ns.add5( -0.0, 0.0, -0.0, -0.0, -0.0 );
221-
* // returns 0.0
222-
*
223-
* @example
224-
* var v = ns.add5( NaN, NaN, NaN, NaN, NaN );
225-
* // returns NaN
226-
*/
227-
add5: typeof add5;
228-
229196
/**
230197
* Computes the sum of two single-precision floating-point numbers `x` and `y`.
231198
*

0 commit comments

Comments
 (0)