Skip to content

Commit

Permalink
feat!: update namespace TypeScript declarations
Browse files Browse the repository at this point in the history 
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]>
  • Loading branch information
@stdlib-bot
stdlib-bot authored Feb 16, 2025
1 parent 158bfde commit 76cf95f
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 174 deletions.
140 changes: 14 additions & 126 deletions lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2037,44 +2037,24 @@ interface Namespace {
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var za = new Complex128( 2.0, 2.0 );
*
* ns.zaxpy( 2, za, zx, 2, zy, 2 );
*
* var z = zy.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns -1.0
*
* var im = imag( z );
* // returns 7.0
* // zy => <Complex128Array>[ -1.0, 7.0, 1.0, 1.0, -1.0, 23.0, 1.0, 1.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var zy = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var za = new Complex128( 2.0, 2.0 );
*
* ns.zaxpy.ndarray( 3, za, zx, 1, 1, zy, 1, 1 );
*
* var z = zy.get( 3 );
* // returns <Complex128>
*
* var re = real( z );
* // returns -1.0
*
* var im = imag( z );
* // returns 31.0
* // zy => <Complex128Array>[ 1.0, 1.0, -1.0, 15.0, -1.0, 23.0, -1.0, 31.0 ]
*/
zaxpy: typeof zaxpy;

Expand Down Expand Up @@ -2122,59 +2102,23 @@ interface Namespace {
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zdrot( 2, zx, 2, zy, 1, 0.8, 0.6 );
*
* var z = zy.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns -0.6
*
* var im = imag( z );
* // returns -1.2
*
* z = zx.get( 0 );
* // returns <Complex128>
*
* re = real( z );
* // returns 0.8
*
* im = imag( z );
* // returns 1.6
* // zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
* // zy => <Complex128Array>[ ~-0.6, ~-1.2, -3.0, ~-3.6, 0.0, 0.0, 0.0, 0.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
* var zy = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zdrot.ndarray( 2, zx, 2, 0, zy, 1, 0, 0.8, 0.6 );
*
* var z = zy.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns -0.6
*
* var im = imag( z );
* // returns -1.2
*
* z = zx.get( 0 );
* // returns <Complex128>
*
* re = real( z );
* // returns 0.8
*
* im = imag( z );
* // returns 1.6
* // zx => <Complex128Array>[ ~0.8, ~1.6, 3.0, 4.0, 4.0, ~4.8, 7.0, 8.0 ]
* // zy => <Complex128Array>[ ~-0.6, ~-1.2, -3.0, ~-3.6, 0.0, 0.0, 0.0, 0.0 ]
*/
zdrot: typeof zdrot;

Expand All @@ -2190,42 +2134,22 @@ interface Namespace {
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var za = new Complex128( 2.0, 2.0 );
*
* ns.zscal( 3, za, zx, 1 );
*
* var z = zx.get( 1 );
* // returns <Complex128>
*
* var re = real( z );
* // returns -2.0
*
* var im = imag( z );
* // returns 14.0
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var za = new Complex128( 2.0, 2.0 );
*
* ns.zscal.ndarray( 2, za, zx, 1, 1 );
*
* var z = zx.get( 1 );
* // returns <Complex128>
*
* var re = real( z );
* // returns -2.0
*
* var im = imag( z );
* // returns 14.0
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
*/
zscal: typeof zscal;

Expand All @@ -2241,59 +2165,23 @@ interface Namespace {
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zswap( x.length, x, 1, y, 1 );
*
* var z = y.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 1.0
*
* var im = imag( z );
* // returns 2.0
*
* z = x.get( 0 );
* // returns <Complex128>
*
* re = real( z );
* // returns 7.0
*
* im = imag( z );
* // returns 8.0
* // x => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var real = require( '@stdlib/complex/float64/real' );
* var imag = require( '@stdlib/complex/float64/imag' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
* var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zswap.ndarray( x.length, x, 1, 0, y, 1, 0 );
*
* var z = y.get( 0 );
* // returns <Complex128>
*
* var re = real( z );
* // returns 1.0
*
* var im = imag( z );
* // returns 2.0
*
* z = x.get( 0 );
* // returns <Complex128>
*
* re = real( z );
* // returns 7.0
*
* im = imag( z );
* // returns 8.0
* // x => <Complex128Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
*/
zswap: typeof zswap;
}
Expand Down
30 changes: 15 additions & 15 deletions lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -364,9 +364,9 @@ interface Namespace {
* @param N - number of indexed elements
* @param sum - initial sum
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - `y` stride length
* @param strideY - stride length for `y`
* @returns output array
*
* @example
Expand Down Expand Up @@ -426,9 +426,9 @@ interface Namespace {
* @param N - number of indexed elements
* @param sum - initial sum
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - `y` stride length
* @param strideY - stride length for `y`
* @returns output array
*
* @example
Expand Down Expand Up @@ -486,7 +486,7 @@ interface Namespace {
* Fills a double-precision floating-point strided array with a specified scalar value.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param strideX - stride length
* @returns input array
Expand Down Expand Up @@ -566,9 +566,9 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
* @param strideOut - `out` stride length
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
Expand Down Expand Up @@ -596,9 +596,9 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
* @param strideOut - `out` stride length
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
Expand Down Expand Up @@ -626,9 +626,9 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
* @param strideOut - `out` stride length
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
Expand Down Expand Up @@ -656,9 +656,9 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
* @param strideOut - `out` stride length
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
Expand Down Expand Up @@ -686,9 +686,9 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param out - output array whose first element is the sum and whose second element is the number of non-NaN elements
* @param strideOut - `out` stride length
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
Expand Down
33 changes: 0 additions & 33 deletions lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import caddf = require( '@stdlib/complex/float32/base/add' );
import cmulf = require( '@stdlib/complex/float32/base/mul' );
import cadd = require( '@stdlib/complex/float64/base/add' );
import cmul = require( '@stdlib/complex/float64/base/mul' );
import add5 = require( '@stdlib/number/float64/base/add5' );
import addf = require( '@stdlib/math/base/ops/addf' );
import cdiv = require( '@stdlib/math/base/ops/cdiv' );
import cneg = require( '@stdlib/math/base/ops/cneg' );
Expand Down Expand Up @@ -194,38 +193,6 @@ interface Namespace {
*/
cmul: typeof cmul;

/**
* Computes the sum of five double-precision floating-point numbers.
*
* @param x - first input value
* @param y - second input value
* @param z - third input value
* @param w - fourth input value
* @param u - fifth input value
* @returns sum
*
* @example
* var v = ns.add5( -1.0, 5.0, 2.0, -3.0, 4.0 );
* // returns 7.0
*
* @example
* var v = ns.add5( 2.0, 5.0, 2.0, -3.0, 4.0 );
* // returns 10.0
*
* @example
* var v = ns.add5( 0.0, 5.0, 2.0, -3.0, 4.0 );
* // returns 8.0
*
* @example
* var v = ns.add5( -0.0, 0.0, -0.0, -0.0, -0.0 );
* // returns 0.0
*
* @example
* var v = ns.add5( NaN, NaN, NaN, NaN, NaN );
* // returns NaN
*/
add5: typeof add5;

/**
* Computes the sum of two single-precision floating-point numbers `x` and `y`.
*
Expand Down

1 comment on commit 76cf95f

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
blas/base $\color{green}789/789$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}789/789$
$\color{green}+100.00\%$
blas/ext/base $\color{green}1068/1068$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}1068/1068$
$\color{green}+100.00\%$
math/base/ops $\color{green}222/222$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}222/222$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.