Skip to content

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

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 10, 2026
Merged

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

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
141 changes: 141 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 @@ -23,8 +23,10 @@
import capx = require( '@stdlib/blas/ext/base/capx' );
import caxpb = require( '@stdlib/blas/ext/base/caxpb' );
import caxpby = require( '@stdlib/blas/ext/base/caxpby' );
import ccopyWithin = require( '@stdlib/blas/ext/base/ccopy-within' );
import cdiff = require( '@stdlib/blas/ext/base/cdiff' );
import cfill = require( '@stdlib/blas/ext/base/cfill' );
import cfillEqual = require( '@stdlib/blas/ext/base/cfill-equal' );
import cindexOf = require( '@stdlib/blas/ext/base/cindex-of' );
import cindexOfColumn = require( '@stdlib/blas/ext/base/cindex-of-column' );
import cindexOfFalsy = require( '@stdlib/blas/ext/base/cindex-of-falsy' );
Expand Down Expand Up @@ -253,6 +255,7 @@ import gsumkbn2 = require( '@stdlib/blas/ext/base/gsumkbn2' );
import gsumors = require( '@stdlib/blas/ext/base/gsumors' );
import gsumpw = require( '@stdlib/blas/ext/base/gsumpw' );
import gtril = require( '@stdlib/blas/ext/base/gtril' );
import gtril2triu = require( '@stdlib/blas/ext/base/gtril2triu' );
import gtriu = require( '@stdlib/blas/ext/base/gtriu' );
import gtriu2tril = require( '@stdlib/blas/ext/base/gtriu2tril' );
import gunitspace = require( '@stdlib/blas/ext/base/gunitspace' );
Expand Down Expand Up @@ -376,6 +379,7 @@ import zaxpb = require( '@stdlib/blas/ext/base/zaxpb' );
import zaxpby = require( '@stdlib/blas/ext/base/zaxpby' );
import zcartesianProduct = require( '@stdlib/blas/ext/base/zcartesian-product' );
import zcartesianSquare = require( '@stdlib/blas/ext/base/zcartesian-square' );
import zcopyWithin = require( '@stdlib/blas/ext/base/zcopy-within' );
import zdiff = require( '@stdlib/blas/ext/base/zdiff' );
import zfill = require( '@stdlib/blas/ext/base/zfill' );
import zindexOf = require( '@stdlib/blas/ext/base/zindex-of' );
Expand Down Expand Up @@ -520,6 +524,43 @@ interface Namespace {
*/
caxpby: typeof caxpby;

/**
* Performs an in-place copy of elements within a single-precision complex floating-point 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 Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
* var w = new Complex64Array( x.length );
*
* ns.ccopyWithin( x.length, 3, 1, 4, x, 1, w, 1 );
* // x => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
* var w = new Complex64Array( x.length );
*
* ns.ccopyWithin.ndarray( x.length, 3, 1, 4, x, 1, 0, w, 1, 0 );
* // x => <Complex64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
*/
ccopyWithin: typeof ccopyWithin;

/**
* Calculates the k-th discrete forward difference of a single-precision complex floating-point strided array.
*
Expand Down Expand Up @@ -603,6 +644,40 @@ interface Namespace {
*/
cfill: typeof cfill;

/**
* Replaces single-precision complex floating-point strided array elements equal to 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 Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] );
* var searchElement = new Complex64( 0.0, 0.0 );
* var alpha = new Complex64( 5.0, 5.0 );
*
* ns.cfillEqual( x.length, searchElement, alpha, x, 1 );
* // x => <Complex64Array>[ 1.0, 2.0, 5.0, 5.0, 3.0, 4.0, 5.0, 5.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
*
* var x = new Complex64Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] );
* var searchElement = new Complex64( 0.0, 0.0 );
* var alpha = new Complex64( 5.0, 5.0 );
*
* ns.cfillEqual.ndarray( x.length, searchElement, alpha, x, 1, 0 );
* // x => <Complex64Array>[ 1.0, 2.0, 5.0, 5.0, 3.0, 4.0, 5.0, 5.0 ]
*/
cfillEqual: typeof cfillEqual;

/**
* Returns the first index of a specified search element in a single-precision complex floating-point strided array.
*
Expand Down Expand Up @@ -7402,6 +7477,35 @@ interface Namespace {
*/
gtril: typeof gtril;

/**
* Reflects the lower triangular part of a matrix `A` into the upper triangular part of another matrix `B`.
*
* @param order - storage layout of `A` and `B`
* @param M - number of rows in matrix `A`
* @param N - number of columns in matrix `A`
* @param k - diagonal above which to ignore
* @param A - input matrix
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param B - output matrix
* @param LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
* @returns `B`
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0 ];
* var B = [ 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gtril2triu( 'row-major', 2, 2, 0, A, 2, B, 2 );
* // B => [ 1.0, 3.0, 0.0, 4.0 ]
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0 ];
* var B = [ 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gtril2triu.ndarray( 2, 2, 0, A, 2, 1, 0, B, 2, 1, 0 );
* // B => [ 1.0, 3.0, 0.0, 4.0 ]
*/
gtril2triu: typeof gtril2triu;

/**
* Copies the upper triangular part of a matrix `A` to another matrix `B`.
*
Expand Down Expand Up @@ -11116,6 +11220,43 @@ interface Namespace {
*/
zcartesianSquare: typeof zcartesianSquare;

/**
* Performs an in-place copy of elements within a double-precision complex floating-point 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 Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
* var w = new Complex128Array( x.length );
*
* ns.zcopyWithin( x.length, 3, 1, 4, x, 1, w, 1 );
* // x => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
* var w = new Complex128Array( x.length );
*
* ns.zcopyWithin.ndarray( x.length, 3, 1, 4, x, 1, 0, w, 1, 0 );
* // x => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ]
*/
zcopyWithin: typeof zcopyWithin;

/**
* Calculates the k-th discrete forward difference of a double-precision complex floating-point strided array.
*
Expand Down