Skip to content

feat!: update namespace TypeScript declarations #5254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 17, 2025
Merged

feat!: update namespace TypeScript declarations #5254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
View file
Open in desktop
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
19 changes: 19 additions & 0 deletions lib/node_modules/@stdlib/complex/float32/base/docs/types/index.d.ts
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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