Skip to content

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

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 28, 2026
+122 −0
Merged

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

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
122 changes: 122 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 @@ -34,6 +34,7 @@ import dapxsumkbn2 = require( '@stdlib/blas/ext/base/dapxsumkbn2' );
import dapxsumors = require( '@stdlib/blas/ext/base/dapxsumors' );
import dapxsumpw = require( '@stdlib/blas/ext/base/dapxsumpw' );
import dasumpw = require( '@stdlib/blas/ext/base/dasumpw' );
import dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' );
import dcircshift = require( '@stdlib/blas/ext/base/dcircshift' );
import dcusum = require( '@stdlib/blas/ext/base/dcusum' );
import dcusumkbn = require( '@stdlib/blas/ext/base/dcusumkbn' );
Expand Down Expand Up @@ -104,6 +105,7 @@ import gcusumkbn = require( '@stdlib/blas/ext/base/gcusumkbn' );
import gcusumkbn2 = require( '@stdlib/blas/ext/base/gcusumkbn2' );
import gcusumors = require( '@stdlib/blas/ext/base/gcusumors' );
import gcusumpw = require( '@stdlib/blas/ext/base/gcusumpw' );
import gdiff = require( '@stdlib/blas/ext/base/gdiff' );
import gfill = require( '@stdlib/blas/ext/base/gfill' );
import gfillBy = require( '@stdlib/blas/ext/base/gfill-by' );
import gfindIndex = require( '@stdlib/blas/ext/base/gfind-index' );
Expand Down Expand Up @@ -190,6 +192,7 @@ import ssumors = require( '@stdlib/blas/ext/base/ssumors' );
import ssumpw = require( '@stdlib/blas/ext/base/ssumpw' );
import sunitspace = require( '@stdlib/blas/ext/base/sunitspace' );
import svander = require( '@stdlib/blas/ext/base/svander' );
import swhere = require( '@stdlib/blas/ext/base/swhere' );
import szeroTo = require( '@stdlib/blas/ext/base/szero-to' );
import wasm = require( '@stdlib/blas/ext/base/wasm' );
import zfill = require( '@stdlib/blas/ext/base/zfill' );
Expand Down Expand Up @@ -602,6 +605,37 @@ interface Namespace {
*/
dasumpw: typeof dasumpw;

/**
* Computes the Cartesian square for a double-precision floating-point strided array.
*
* @param order - storage layout
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length for `x`
* @param out - output array
* @param LDO - stride length between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of `out`)
* @returns output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0 ] );
* var out = new Float64Array( 8 );
*
* ns.dcartesianSquare( 'row-major', x.length, x, 1, out, 2 );
* // out => <Float64Array>[ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0 ] );
* var out = new Float64Array( 8 );
*
* ns.dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 );
* // out => <Float64Array>[ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ]
*/
dcartesianSquare: typeof dcartesianSquare;

/**
* Circularly shifts the elements of a double-precision floating-point strided array by a specified number of positions.
*
Expand Down Expand Up @@ -2609,6 +2643,56 @@ interface Namespace {
*/
gcusumpw: typeof gcusumpw;

/**
* Calculates the k-th discrete forward difference of a strided array.
*
* ## Notes
*
* - The `out` array must have `N + N1 + N2 - k` elements.
* - The `workspace` array must have `N + N1 + N2 - 1` elements.
*
* @param N - number of indexed elements
* @param k - number of times to recursively compute differences
* @param x - input array
* @param strideX - stride length for `x`
* @param N1 - number of indexed elements for `prepend`
* @param prepend - prepend array
* @param strideP - stride length for `prepend`
* @param N2 - number of indexed elements for `append`
* @param append - append array
* @param strideA - stride length for `append`
* @param out - output array
* @param strideOut - stride length for `out`
* @param workspace - workspace array
* @param strideW - stride length for `workspace`
* @returns output array
*
* @example
* var x = [ 2.0, 4.0, 7.0, 11.0, 16.0 ];
* var p = [ 1.0 ];
* var a = [ 22.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
* var w = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gdiff( x.length, 2, x, 1, 1, p, 1, 1, a, 1, out, 1, w, 1 );
*
* console.log( out );
* // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ]
*
* @example
* var x = [ 2.0, 4.0, 7.0, 11.0, 16.0 ];
* var p = [ 1.0 ];
* var a = [ 22.0 ];
* var out = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
* var w = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* ns.gdiff.ndarray( x.length, 2, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0, w, 1, 0 );
*
* console.log( out );
* // => [ 1.0, 1.0, 1.0, 1.0, 1.0 ]
*/
gdiff: typeof gdiff;

/**
* Fills a strided array with a specified scalar constant.
*
Expand Down Expand Up @@ -5036,6 +5120,44 @@ interface Namespace {
*/
svander: typeof svander;

/**
* Takes elements from one of two single-precision floating-point strided arrays depending on a condition.
*
* @param N - number of indexed elements
* @param condition - condition array
* @param strideC - stride length for `condition`
* @param x - first input array
* @param strideX - stride length for `x`
* @param y - second input array
* @param strideY - stride length for `y`
* @param out - output array
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
* var BooleanArray = require( '@stdlib/array/bool' );
*
* var condition = new BooleanArray( [ true, false, true ] );
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float32Array( [ 4.0, 5.0, 6.0 ] );
* var out = new Float32Array( [ 0.0, 0.0, 0.0 ] );
*
* ns.swhere( 3, condition, 1, x, 1, y, 1, out, 1 );
* // out => <Float32Array>[ 1.0, 5.0, 3.0 ]
*
* @example
* var BooleanArray = require( '@stdlib/array/bool' );
*
* var condition = new BooleanArray( [ true, false, true ] );
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float32Array( [ 4.0, 5.0, 6.0 ] );
* var out = new Float32Array( [ 0.0, 0.0, 0.0 ] );
*
* ns.swhere.ndarray( 3, condition, 1, 0, x, 1, 0, y, 1, 0, out, 1, 0 );
* // out => <Float32Array>[ 1.0, 5.0, 3.0 ]
*/
swhere: typeof swhere;

/**
* Fills a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.
*
Expand Down