Skip to content

Commit 211d758

Browse files
authored
feat!: update namespace TypeScript declarations
This commit removes `mulf` from the `math/base/ops` namespace. BREAKING CHANGE: remove `mulf` from `math/base/ops` namespace To migrate, users should access the same symbol via the `number/float32/base` namespace. PR-URL: #5511 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent c4898b7 commit 211d758

File tree

3 files changed

+3
-33
lines changed

3 files changed

+3
-33
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1171,10 +1171,10 @@ interface Namespace {
11711171
gnrm2: typeof gnrm2;
11721172

11731173
/**
1174-
* Multiplies a vector `x` by a constant `alpha`.
1174+
* Multiplies a vector by a scalar constant.
11751175
*
11761176
* @param N - number of indexed elements
1177-
* @param alpha - constant
1177+
* @param alpha - scalar constant
11781178
* @param x - input array
11791179
* @param stride - stride length
11801180
* @returns input array

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import tools = require( '@stdlib/math/array/tools' );
2828
*/
2929
interface Namespace {
3030
/**
31-
* Namespace.
31+
* Special math functions applied to arrays.
3232
*/
3333
special: typeof special;
3434

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

-30
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ import csub = require( '@stdlib/math/base/ops/csub' );
3131
import csubf = require( '@stdlib/math/base/ops/csubf' );
3232
import imul = require( '@stdlib/math/base/ops/imul' );
3333
import imuldw = require( '@stdlib/math/base/ops/imuldw' );
34-
import mulf = require( '@stdlib/number/float32/base/mul' );
3534
import umuldw = require( '@stdlib/math/base/ops/umuldw' );
3635
import addf = require( '@stdlib/number/float32/base/add' );
3736
import divf = require( '@stdlib/number/float32/base/div' );
@@ -445,35 +444,6 @@ interface Namespace {
445444
*/
446445
imuldw: typeof imuldw;
447446

448-
/**
449-
* Multiplies two single-precision floating-point numbers `x` and `y`.
450-
*
451-
* @param x - first input value
452-
* @param y - second input value
453-
* @returns result
454-
*
455-
* @example
456-
* var v = ns.mulf( -1.0, 5.0 );
457-
* // returns -5.0
458-
*
459-
* @example
460-
* var v = ns.mulf( 2.0, 5.0 );
461-
* // returns 10.0
462-
*
463-
* @example
464-
* var v = ns.mulf( 0.0, 5.0 );
465-
* // returns 0.0
466-
*
467-
* @example
468-
* var v = ns.mulf( -0.0, 0.0 );
469-
* // returns -0.0
470-
*
471-
* @example
472-
* var v = ns.mulf( NaN, NaN );
473-
* // returns NaN
474-
*/
475-
mulf: typeof mulf;
476-
477447
/**
478448
* Performs multiplication of two unsigned 32-bit integers and returns an array of two unsigned 32-bit integers which represents the unsigned 64-bit integer product.
479449
*

0 commit comments

Comments
 (0)