Skip to content

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

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
Apr 13, 2026
Merged

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

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
92 changes: 75 additions & 17 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 @@ -118,6 +118,7 @@ import gnansumkbn2 = require( '@stdlib/blas/ext/base/gnansumkbn2' );
import gnansumors = require( '@stdlib/blas/ext/base/gnansumors' );
import gnansumpw = require( '@stdlib/blas/ext/base/gnansumpw' );
import goneTo = require( '@stdlib/blas/ext/base/gone-to' );
import greplicate = require( '@stdlib/blas/ext/base/greplicate' );
import grev = require( '@stdlib/blas/ext/base/grev' );
import gsort = require( '@stdlib/blas/ext/base/gsort' );
import gsort2hp = require( '@stdlib/blas/ext/base/gsort2hp' );
Expand All @@ -131,6 +132,7 @@ import gsumkbn = require( '@stdlib/blas/ext/base/gsumkbn' );
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 gvander = require( '@stdlib/blas/ext/base/gvander' );
import gzeroTo = require( '@stdlib/blas/ext/base/gzero-to' );
import ndarray = require( '@stdlib/blas/ext/base/ndarray' );
import sapx = require( '@stdlib/blas/ext/base/sapx' );
Expand Down Expand Up @@ -241,8 +243,8 @@ interface Namespace {
* @returns row index
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
Expand All @@ -252,8 +254,8 @@ interface Namespace {
* // returns 1
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
Expand Down Expand Up @@ -816,8 +818,8 @@ interface Namespace {
* @returns row index
*
* @example
* var Float64Array = require( `@stdlib/array/float64` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Float64Array = require( '@stdlib/array/float64' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
* var x = new Float64Array( [ 2.0, 4.0 ] );
Expand All @@ -827,8 +829,8 @@ interface Namespace {
* // returns 1
*
* @example
* var Float64Array = require( `@stdlib/array/float64` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Float64Array = require( '@stdlib/array/float64' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
* var x = new Float64Array( [ 2.0, 4.0 ] );
Expand Down Expand Up @@ -2965,6 +2967,33 @@ interface Namespace {
*/
goneTo: typeof goneTo;

/**
* Replicates each strided array element a specified number of times.
*
* @param N - number of indexed elements
* @param k - number of times to replicate each element
* @param x - input array
* @param strideX - stride length for `x`
* @param out - output array
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
* var x = [ 1.0, 2.0, 3.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.greplicate( x.length, 2, x, 1, out, 1 );
* // out => [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
*
* @example
* var x = [ 1.0, 2.0, 3.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.greplicate.ndarray( x.length, 2, x, 1, 0, out, 1, 0 );
* // out => [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
*/
greplicate: typeof greplicate;

/**
* Reverses a strided array in-place.
*
Expand Down Expand Up @@ -3300,6 +3329,35 @@ interface Namespace {
*/
gsumpw: typeof gsumpw;

/**
* Generates a Vandermonde matrix.
*
* @param order - storage layout
* @param mode - mode indicating whether to generate increasing or decreasing powers
* @param M - number of rows in `out`
* @param N - number of columns in `out`
* @param x - input array
* @param strideX - stride length for `x`
* @param out - output matrix
* @param ldo - stride between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of the matrix `out`)
* @returns output matrix
*
* @example
* var x = [ 1.0, 2.0, 3.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gvander( 'row-major', 1, 3, 3, x, 1, out, 3 );
* // out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
*
* @example
* var x = [ 1.0, 2.0, 3.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gvander.ndarray( 1, 3, 3, x, 1, 0, out, 3, 1, 0 );
* // out => [ 1.0, 1.0, 1.0, 1.0, 2.0, 4.0, 1.0, 3.0, 9.0 ]
*/
gvander: typeof gvander;

/**
* Fills a strided array with linearly spaced numeric elements which increment by `1` starting from zero.
*
Expand Down Expand Up @@ -3933,8 +3991,8 @@ interface Namespace {
* @returns row index
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Float32Array = require( '@stdlib/array/float32' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
* var x = new Float32Array( [ 2.0, 4.0 ] );
Expand All @@ -3944,8 +4002,8 @@ interface Namespace {
* // returns 1
*
* @example
* var Float32Array = require( `@stdlib/array/float32` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Float32Array = require( '@stdlib/array/float32' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] );
* var x = new Float32Array( [ 2.0, 4.0 ] );
Expand Down Expand Up @@ -4343,7 +4401,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param order - sort order
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns input array
*
* @example
Expand Down Expand Up @@ -4625,8 +4683,8 @@ interface Namespace {
* @returns row index
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Complex128Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
* var x = new Complex128Array( [ 2.0, 0.0, 4.0, 0.0 ] );
Expand All @@ -4636,8 +4694,8 @@ interface Namespace {
* // returns 1
*
* @example
* var Complex128Array = require( `@stdlib/array/complex128` );
* var Uint8Array = require( `@stdlib/array/uint8` );
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Uint8Array = require( '@stdlib/array/uint8' );
*
* var A = new Complex128Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
* var x = new Complex128Array( [ 2.0, 0.0, 4.0, 0.0 ] );
Expand Down