Skip to content

feat: update blas/ext/base TypeScript declarations #13853

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
kgryte merged 1 commit into from
Aug 2, 2026
Merged

feat: update blas/ext/base TypeScript declarations #13853

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
199 changes: 199 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import cwapx = require( '@stdlib/blas/ext/base/cwapx' );
import cwax = require( '@stdlib/blas/ext/base/cwax' );
import cwhere = require( '@stdlib/blas/ext/base/cwhere' );
import cwxsa = require( '@stdlib/blas/ext/base/cwxsa' );
import cwxsy = require( '@stdlib/blas/ext/base/cwxsy' );
import cxmy = require( '@stdlib/blas/ext/base/cxmy' );
import cxpy = require( '@stdlib/blas/ext/base/cxpy' );
import cxsa = require( '@stdlib/blas/ext/base/cxsa' );
Expand Down Expand Up @@ -73,6 +74,7 @@ import ddiff = require( '@stdlib/blas/ext/base/ddiff' );
import dediff = require( '@stdlib/blas/ext/base/dediff' );
import dfill = require( '@stdlib/blas/ext/base/dfill' );
import dfillEqual = require( '@stdlib/blas/ext/base/dfill-equal' );
import dfillLessThan = require( '@stdlib/blas/ext/base/dfill-less-than' );
import dfillNaN = require( '@stdlib/blas/ext/base/dfill-nan' );
import dfillNotEqual = require( '@stdlib/blas/ext/base/dfill-not-equal' );
import dfirstIndexEqual = require( '@stdlib/blas/ext/base/dfirst-index-equal' );
Expand All @@ -84,6 +86,7 @@ import dindexOfFalsy = require( '@stdlib/blas/ext/base/dindex-of-falsy' );
import dindexOfNotEqual = require( '@stdlib/blas/ext/base/dindex-of-not-equal' );
import dindexOfRow = require( '@stdlib/blas/ext/base/dindex-of-row' );
import dindexOfTruthy = require( '@stdlib/blas/ext/base/dindex-of-truthy' );
import dlastIndexEqual = require( '@stdlib/blas/ext/base/dlast-index-equal' );
import dlastIndexOf = require( '@stdlib/blas/ext/base/dlast-index-of' );
import dlastIndexOfFalsy = require( '@stdlib/blas/ext/base/dlast-index-of-falsy' );
import dlastIndexOfRow = require( '@stdlib/blas/ext/base/dlast-index-of-row' );
Expand Down Expand Up @@ -170,6 +173,7 @@ import gcartesianProduct = require( '@stdlib/blas/ext/base/gcartesian-product' )
import gcartesianSquare = require( '@stdlib/blas/ext/base/gcartesian-square' );
import gcircshift = require( '@stdlib/blas/ext/base/gcircshift' );
import gconjoin = require( '@stdlib/blas/ext/base/gconjoin' );
import gcopyWithin = require( '@stdlib/blas/ext/base/gcopy-within' );
import gcuany = require( '@stdlib/blas/ext/base/gcuany' );
import gcuevery = require( '@stdlib/blas/ext/base/gcuevery' );
import gcunone = require( '@stdlib/blas/ext/base/gcunone' );
Expand Down Expand Up @@ -247,6 +251,7 @@ import gwapx = require( '@stdlib/blas/ext/base/gwapx' );
import gwax = require( '@stdlib/blas/ext/base/gwax' );
import gwaxpb = require( '@stdlib/blas/ext/base/gwaxpb' );
import gwhere = require( '@stdlib/blas/ext/base/gwhere' );
import gwxdy = require( '@stdlib/blas/ext/base/gwxdy' );
import gwxmy = require( '@stdlib/blas/ext/base/gwxmy' );
import gwxpy = require( '@stdlib/blas/ext/base/gwxpy' );
import gwxsa = require( '@stdlib/blas/ext/base/gwxsa' );
Expand Down Expand Up @@ -378,6 +383,7 @@ import zwax = require( '@stdlib/blas/ext/base/zwax' );
import zwhere = require( '@stdlib/blas/ext/base/zwhere' );
import zwxmy = require( '@stdlib/blas/ext/base/zwxmy' );
import zwxsa = require( '@stdlib/blas/ext/base/zwxsa' );
import zwxsy = require( '@stdlib/blas/ext/base/zwxsy' );
import zxdy = require( '@stdlib/blas/ext/base/zxdy' );
import zxmy = require( '@stdlib/blas/ext/base/zxmy' );
import zxpy = require( '@stdlib/blas/ext/base/zxpy' );
Expand Down Expand Up @@ -1160,6 +1166,40 @@ interface Namespace {
*/
cwxsa: typeof cwxsa;

/**
* Subtracts elements of a single-precision complex floating-point strided array `y` from the corresponding elements of a single-precision complex floating-point strided array `x` and assigns the results to elements in a single-precision complex floating-point strided array `w`.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - `x` stride length
* @param y - second input array
* @param strideY - `y` stride length
* @param w - output array
* @param strideW - `w` stride length
* @returns output array
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex64Array( [ 1.0, 3.0, -2.0, 1.0, 3.0, 4.0 ] );
* var w = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.cwxsy( x.length, x, 1, y, 1, w, 1 );
* // w => <Complex64Array>[ 0.0, -1.0, 5.0, 3.0, 2.0, 2.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex64Array( [ 1.0, 3.0, -2.0, 1.0, 3.0, 4.0 ] );
* var w = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.cwxsy.ndarray( x.length, x, 1, 0, y, 1, 0, w, 1, 0 );
* // w => <Complex64Array>[ 0.0, -1.0, 5.0, 3.0, 2.0, 2.0 ]
*/
cwxsy: typeof cwxsy;

/**
* Multiplies elements of a single-precision complex floating-point strided array `x` by the corresponding elements of a single-precision complex floating-point strided array `y` and assigns the results to `y`.
*
Expand Down Expand Up @@ -2150,6 +2190,34 @@ interface Namespace {
*/
dfillEqual: typeof dfillEqual;

/**
* Replaces double-precision floating-point strided array elements less than a provided search element with a specified scalar constant.
*
* @param N - number of indexed elements
* @param searchElement - search element
* @param alpha - scalar constant
* @param x - input array
* @param strideX - stride length
* @returns `x`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] );
*
* ns.dfillLessThan( x.length, 2.0, 5.0, x, 1 );
* // x => <Float64Array>[ 5.0, 5.0, 3.0, 5.0, 4.0, 5.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] );
*
* ns.dfillLessThan.ndarray( x.length, 2.0, 5.0, x, 1, 0 );
* // x => <Float64Array>[ 5.0, 5.0, 3.0, 5.0, 4.0, 5.0 ]
*/
dfillLessThan: typeof dfillLessThan;

/**
* Replaces double-precision floating-point strided array elements equal to `NaN` with a specified scalar constant.
*
Expand Down Expand Up @@ -2513,6 +2581,40 @@ interface Namespace {
*/
dindexOfTruthy: typeof dindexOfTruthy;

/**
* Returns the index of the last element in a double-precision floating-point strided array equal to a corresponding element in another double-precision floating-point strided array.
*
* ## Notes
*
* - If the function is unable to find matching elements, the function returns `-1`.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - stride length for `x`
* @param y - second input array
* @param strideY - stride length for `y`
* @returns index
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = new Float64Array( [ 0.0, 0.0, 3.0, 0.0 ] );
*
* var idx = ns.dlastIndexEqual( 4, x, 1, y, 1 );
* // returns 2
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var y = new Float64Array( [ 0.0, 0.0, 3.0, 0.0 ] );
*
* var idx = ns.dlastIndexEqual.ndarray( 4, x, 1, 0, y, 1, 0 );
* // returns 2
*/
dlastIndexEqual: typeof dlastIndexEqual;

/**
* Returns the last index of a specified search element in a double-precision floating-point strided array.
*
Expand Down Expand Up @@ -5008,6 +5110,39 @@ interface Namespace {
*/
gconjoin: typeof gconjoin;

/**
* Performs an in-place copy of elements within a strided array.
*
* ## Notes
*
* - If the `start` and `target` index ranges do not overlap, the `workspace` array is unused and thus ignored.
*
* @param N - number of indexed elements
* @param target - target index
* @param start - source start index (inclusive)
* @param end - source end index (exclusive)
* @param x - input array
* @param strideX - stride length for `x`
* @param workspace - workspace array
* @param strideW - stride length for `workspace`
* @returns `x`
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var w = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gcopyWithin( 6, 3, 1, 4, x, 1, w, 1 );
* // x => [ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var w = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gcopyWithin.ndarray( 6, 3, 1, 4, x, 1, 0, w, 1, 0 );
* // x => [ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
*/
gcopyWithin: typeof gcopyWithin;

/**
* Cumulatively tests whether at least one element in a strided array is truthy.
*
Expand Down Expand Up @@ -7155,6 +7290,36 @@ interface Namespace {
*/
gwhere: typeof gwhere;

/**
* Divides elements of a strided array `x` by the corresponding elements of a strided array `y` and assigns the results to elements in a strided array `w`.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - `x` stride length
* @param y - second input array
* @param strideY - `y` stride length
* @param w - output array
* @param strideW - `w` stride length
* @returns `w`
*
* @example
* var x = [ 4.0, 6.0, 12.0, 20.0, 30.0 ];
* var y = [ 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var w = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gwxdy( x.length, x, 1, y, 1, w, 1 );
* // w => [ 2.0, 2.0, 3.0, 4.0, 5.0 ]
*
* @example
* var x = [ 4.0, 6.0, 12.0, 20.0, 30.0 ];
* var y = [ 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var w = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gwxdy.ndarray( x.length, x, 1, 0, y, 1, 0, w, 1, 0 );
* // w => [ 2.0, 2.0, 3.0, 4.0, 5.0 ]
*/
gwxdy: typeof gwxdy;

/**
* Multiplies elements of a strided array `x` by the corresponding elements of a strided array `y` and assigns the results to elements in a strided array `w`.
*
Expand Down Expand Up @@ -11219,6 +11384,40 @@ interface Namespace {
*/
zwxsa: typeof zwxsa;

/**
* Subtracts elements of a double-precision complex floating-point strided array `y` from the corresponding elements of a double-precision complex floating-point strided array `x` and assigns the results to elements in a double-precision complex floating-point strided array `w`.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - `x` stride length
* @param y - second input array
* @param strideY - `y` stride length
* @param w - output array
* @param strideW - `w` stride length
* @returns output array
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Array( [ 1.0, 3.0, -2.0, 1.0, 3.0, 4.0 ] );
* var w = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zwxsy( x.length, x, 1, y, 1, w, 1 );
* // w => <Complex128Array>[ 0.0, -1.0, 5.0, 3.0, 2.0, 2.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Array( [ 1.0, 3.0, -2.0, 1.0, 3.0, 4.0 ] );
* var w = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zwxsy.ndarray( x.length, x, 1, 0, y, 1, 0, w, 1, 0 );
* // w => <Complex128Array>[ 0.0, -1.0, 5.0, 3.0, 2.0, 2.0 ]
*/
zwxsy: typeof zwxsy;

/**
* Divides elements of a double-precision complex floating-point strided array `x` by the corresponding elements of a double-precision complex floating-point strided array `y` and assigns the results to `y`.
*
Expand Down