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 `dmaxabs` symbol from the `stats/base` namespace as the corresponding package has been migrated to `stats/strided`

BREAKING CHANGE: remove `dmaxabs`

To migrate, users should access `dmaxabs` via the `stats/strided` namespace.

PR-URL: #5254
Reviewed-by: Athan Reines <[email protected]>
  • Loading branch information
stdlib-bot authored Feb 17, 2025
1 parent b090b90 commit ae8e7b9
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 38 deletions.
22 changes: 11 additions & 11 deletions lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2126,30 +2126,30 @@ interface Namespace {
* Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant.
*
* @param N - number of indexed elements
* @param za - scalar constant
* @param zx - input array
* @param strideX - `zx` stride length
* @param alpha - scalar constant
* @param x - input array
* @param strideX - `x` stride length
* @returns input array
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var za = new Complex128( 2.0, 2.0 );
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var alpha = new Complex128( 2.0, 2.0 );
*
* ns.zscal( 3, za, zx, 1 );
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
* ns.zscal( 3, alpha, x, 1 );
* // x => <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 zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var za = new Complex128( 2.0, 2.0 );
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var alpha = new Complex128( 2.0, 2.0 );
*
* ns.zscal.ndarray( 2, za, zx, 1, 1 );
* // zx => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
* ns.zscal.ndarray( 2, alpha, x, 1, 1 );
* // x => <Complex128Array>[ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ]
*/
zscal: typeof zscal;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,25 @@ interface Namespace {
*
* var im = imagf( out );
* // returns -1.0
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var out = new Float32Array( 2 );
* var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
* // returns <Float32Array>[ -13.0, -1.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var z1 = new Float32Array( [ 5.0, 3.0 ] );
* var z2 = new Float32Array( [ -2.0, 1.0 ] );
*
* var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 );
* // returns <Float32Array>[ -13.0, -1.0 ]
*/
mul: typeof mul;
}
Expand Down
19 changes: 19 additions & 0 deletions lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,25 @@ interface Namespace {
*
* var im = imagf( out );
* // returns -1.0
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var out = new Float32Array( 2 );
* var v = ns.cmulf.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
* // returns <Float32Array>[ -13.0, -1.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var z1 = new Float32Array( [ 5.0, 3.0 ] );
* var z2 = new Float32Array( [ -2.0, 1.0 ] );
*
* var out = ns.cmulf.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 );
* // returns <Float32Array>[ -13.0, -1.0 ]
*/
cmulf: typeof cmulf;

Expand Down
27 changes: 0 additions & 27 deletions lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import cumin = require( '@stdlib/stats/base/cumin' );
import cuminabs = require( '@stdlib/stats/base/cuminabs' );
import dcumin = require( '@stdlib/stats/base/dcumin' );
import dists = require( '@stdlib/stats/base/dists' );
import dmaxabs = require( '@stdlib/stats/strided/dmaxabs' );
import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' );
import dmaxsorted = require( '@stdlib/stats/base/dmaxsorted' );
import dmean = require( '@stdlib/stats/base/dmean' );
Expand Down Expand Up @@ -378,32 +377,6 @@ interface Namespace {
*/
dists: typeof dists;

/**
* Computes the maximum absolute value of a double-precision floating-point strided array.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns maximum absolute value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
*
* var v = ns.dmaxabs( x.length, x, 1 );
* // returns 2.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
*
* var v = ns.dmaxabs.ndarray( x.length, x, 1, 0 );
* // returns 2.0
*/
dmaxabs: typeof dmaxabs;

/**
* Computes the maximum absolute value of a sorted double-precision floating-point strided array.
*
Expand Down

1 comment on commit ae8e7b9

@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\%$
complex/float32/base $\color{green}69/69$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}69/69$
$\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\%$
stats/base $\color{green}1959/1959$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}1959/1959$
$\color{green}+100.00\%$

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

Please sign in to comment.