Skip to content

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

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
Oct 15, 2026
+247 −0
Merged

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

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
247 changes: 247 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 @@ -94,6 +94,7 @@ import dfirstIndexLessThan = require( '@stdlib/blas/ext/base/dfirst-index-less-t
import dindexOf = require( '@stdlib/blas/ext/base/dindex-of' );
import dindexOfColumn = require( '@stdlib/blas/ext/base/dindex-of-column' );
import dindexOfFalsy = require( '@stdlib/blas/ext/base/dindex-of-falsy' );
import dindexOfLessThanEqual = require( '@stdlib/blas/ext/base/dindex-of-less-than-equal' );
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' );
Expand All @@ -102,6 +103,7 @@ 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' );
import dlastIndexOfTruthy = require( '@stdlib/blas/ext/base/dlast-index-of-truthy' );
import dleftPadCircular = require( '@stdlib/blas/ext/base/dleft-pad-circular' );
import dleftPadEdge = require( '@stdlib/blas/ext/base/dleft-pad-edge' );
import dlinspace = require( '@stdlib/blas/ext/base/dlinspace' );
import dlogspace = require( '@stdlib/blas/ext/base/dlogspace' );
Expand Down Expand Up @@ -233,6 +235,8 @@ import gindexOfGreaterThanEqualSorted = require( '@stdlib/blas/ext/base/gindex-o
import gindexOfGreaterThanSorted = require( '@stdlib/blas/ext/base/gindex-of-greater-than-sorted' );
import gindexOfLessThan = require( '@stdlib/blas/ext/base/gindex-of-less-than' );
import gindexOfLessThanEqual = require( '@stdlib/blas/ext/base/gindex-of-less-than-equal' );
import gindexOfLessThanEqualSorted = require( '@stdlib/blas/ext/base/gindex-of-less-than-equal-sorted' );
import gindexOfLessThanSorted = require( '@stdlib/blas/ext/base/gindex-of-less-than-sorted' );
import gindexOfNotEqual = require( '@stdlib/blas/ext/base/gindex-of-not-equal' );
import gindexOfRow = require( '@stdlib/blas/ext/base/gindex-of-row' );
import gindexOfSameValue = require( '@stdlib/blas/ext/base/gindex-of-same-value' );
Expand Down Expand Up @@ -304,6 +308,7 @@ import gwxsa = require( '@stdlib/blas/ext/base/gwxsa' );
import gwxsy = require( '@stdlib/blas/ext/base/gwxsy' );
import gxdy = require( '@stdlib/blas/ext/base/gxdy' );
import gxmy = require( '@stdlib/blas/ext/base/gxmy' );
import gxpby = require( '@stdlib/blas/ext/base/gxpby' );
import gxpy = require( '@stdlib/blas/ext/base/gxpy' );
import gxsa = require( '@stdlib/blas/ext/base/gxsa' );
import gxsy = require( '@stdlib/blas/ext/base/gxsy' );
Expand Down Expand Up @@ -350,6 +355,7 @@ import sfirstIndexLessThan = require( '@stdlib/blas/ext/base/sfirst-index-less-t
import sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
import sindexOfColumn = require( '@stdlib/blas/ext/base/sindex-of-column' );
import sindexOfFalsy = require( '@stdlib/blas/ext/base/sindex-of-falsy' );
import sindexOfLessThanEqual = require( '@stdlib/blas/ext/base/sindex-of-less-than-equal' );
import sindexOfNotEqual = require( '@stdlib/blas/ext/base/sindex-of-not-equal' );
import sindexOfRow = require( '@stdlib/blas/ext/base/sindex-of-row' );
import sindexOfTruthy = require( '@stdlib/blas/ext/base/sindex-of-truthy' );
Expand All @@ -375,6 +381,7 @@ import soneTo = require( '@stdlib/blas/ext/base/sone-to' );
import sones = require( '@stdlib/blas/ext/base/sones' );
import sreplicate = require( '@stdlib/blas/ext/base/sreplicate' );
import srev = require( '@stdlib/blas/ext/base/srev' );
import srightPadCircular = require( '@stdlib/blas/ext/base/sright-pad-circular' );
import ssome = require( '@stdlib/blas/ext/base/ssome' );
import ssort = require( '@stdlib/blas/ext/base/ssort' );
import ssort2hp = require( '@stdlib/blas/ext/base/ssort2hp' );
Expand Down Expand Up @@ -441,6 +448,7 @@ import zunitspace = require( '@stdlib/blas/ext/base/zunitspace' );
import zwapx = require( '@stdlib/blas/ext/base/zwapx' );
import zwax = require( '@stdlib/blas/ext/base/zwax' );
import zwhere = require( '@stdlib/blas/ext/base/zwhere' );
import zwxdy = require( '@stdlib/blas/ext/base/zwxdy' );
import zwxmy = require( '@stdlib/blas/ext/base/zwxmy' );
import zwxpy = require( '@stdlib/blas/ext/base/zwxpy' );
import zwxsa = require( '@stdlib/blas/ext/base/zwxsa' );
Expand Down Expand Up @@ -2940,6 +2948,37 @@ interface Namespace {
*/
dindexOfFalsy: typeof dindexOfFalsy;

/**
* Returns the first index of an element in a double-precision floating-point strided array which is less than or equal to a specified search element.
*
* ## Notes
*
* - If the function is unable to find an element which is less than or equal to the search element, the function returns `-1`.
*
* @param N - number of indexed elements
* @param searchElement - search element
* @param x - input array
* @param strideX - stride length
* @returns index
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 2.0, 3.0, 1.0, 4.0 ] );
*
* var idx = ns.dindexOfLessThanEqual( x.length, 1.0, x, 1 );
* // returns 2
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 2.0, 3.0, 1.0, 4.0 ] );
*
* var idx = ns.dindexOfLessThanEqual.ndarray( x.length, 1.0, x, 1, 0 );
* // returns 2
*/
dindexOfLessThanEqual: typeof dindexOfLessThanEqual;

/**
* Returns the first index of an element in a double-precision floating-point strided array which is not equal to a specified search element.
*
Expand Down Expand Up @@ -3215,6 +3254,37 @@ interface Namespace {
*/
dlastIndexOfTruthy: typeof dlastIndexOfTruthy;

/**
* Prepends elements to a double-precision floating-point strided array by circularly repeating existing elements.
*
* @param N - number of indexed elements in `x`
* @param k - number of elements to pad
* @param x - input array
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - stride length for `y`
* @returns output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.dleftPadCircular( x.length, 2, x, 1, y, 1 );
* // y => <Float64Array>[ 2.0, 3.0, 1.0, 2.0, 3.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.dleftPadCircular.ndarray( x.length, 2, x, 1, 0, y, 1, 0 );
* // y => <Float64Array>[ 2.0, 3.0, 1.0, 2.0, 3.0 ]
*/
dleftPadCircular: typeof dleftPadCircular;

/**
* Prepends elements to a double-precision floating-point strided array by repeating the leading edge element.
*
Expand Down Expand Up @@ -7012,6 +7082,60 @@ interface Namespace {
*/
gindexOfLessThanEqual: typeof gindexOfLessThanEqual;

/**
* Returns the index of the first element in a sorted strided array which is less than or equal to a specified search element.
*
* ## Notes
*
* - If the function is unable to find an element which is less than or equal to a search element, the function returns `-1`.
*
* @param N - number of indexed elements
* @param searchElement - search element
* @param x - sorted input array
* @param strideX - stride length
* @returns index
*
* @example
* var x = [ 1.0, 2.0, 2.0, 3.0 ];
*
* var idx = ns.gindexOfLessThanEqualSorted( x.length, 2.0, x, 1 );
* // returns 0
*
* @example
* var x = [ 1.0, 2.0, 2.0, 3.0 ];
*
* var idx = ns.gindexOfLessThanEqualSorted.ndarray( x.length, 2.0, x, 1, 0 );
* // returns 0
*/
gindexOfLessThanEqualSorted: typeof gindexOfLessThanEqualSorted;

/**
* Returns the index of the first element in a sorted strided array which is less than a specified search element.
*
* ## Notes
*
* - If the function is unable to find an element which is less than a search element, the function returns `-1`.
*
* @param N - number of indexed elements
* @param searchElement - search element
* @param x - sorted input array
* @param strideX - stride length
* @returns index
*
* @example
* var x = [ 1.0, 2.0, 2.0, 3.0 ];
*
* var idx = ns.gindexOfLessThanSorted( x.length, 2.0, x, 1 );
* // returns 0
*
* @example
* var x = [ 1.0, 2.0, 2.0, 3.0 ];
*
* var idx = ns.gindexOfLessThanSorted.ndarray( x.length, 2.0, x, 1, 0 );
* // returns 0
*/
gindexOfLessThanSorted: typeof gindexOfLessThanSorted;

/**
* Returns the first index of an element in a strided array which is not equal to a specified search element.
*
Expand Down Expand Up @@ -8965,6 +9089,33 @@ interface Namespace {
*/
gxmy: typeof gxmy;

/**
* Adds a strided array `x` to a strided array `y` multiplied by a constant.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - `x` stride length
* @param beta - scalar constant
* @param y - output array
* @param strideY - `y` stride length
* @returns `y`
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
* var y = [ 2.0, 3.0, 4.0, 5.0, 6.0 ];
*
* ns.gxpby( x.length, x, 1, 3.0, y, 1 );
* // y => [ 7.0, 11.0, 15.0, 19.0, 23.0 ]
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
* var y = [ 2.0, 3.0, 4.0, 5.0, 6.0 ];
*
* ns.gxpby.ndarray( x.length, x, 1, 0, 3.0, y, 1, 0 );
* // y => [ 7.0, 11.0, 15.0, 19.0, 23.0 ]
*/
gxpby: typeof gxpby;

/**
* Adds elements of a strided array `x` to the corresponding elements of a strided array `y` and assigns the results to `y`.
*
Expand Down Expand Up @@ -10331,6 +10482,37 @@ interface Namespace {
*/
sindexOfFalsy: typeof sindexOfFalsy;

/**
* Returns the first index of an element in a single-precision floating-point strided array which is less than or equal to a specified search element.
*
* ## Notes
*
* - If the function is unable to find an element which is less than or equal to the search element, the function returns `-1`.
*
* @param N - number of indexed elements
* @param searchElement - search element
* @param x - input array
* @param strideX - stride length
* @returns index
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 2.0, 3.0, 1.0, 4.0 ] );
*
* var idx = ns.sindexOfLessThanEqual( x.length, 1.0, x, 1 );
* // returns 2
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 2.0, 3.0, 1.0, 4.0 ] );
*
* var idx = ns.sindexOfLessThanEqual.ndarray( x.length, 1.0, x, 1, 0 );
* // returns 2
*/
sindexOfLessThanEqual: typeof sindexOfLessThanEqual;

/**
* Returns the first index of an element in a single-precision floating-point strided array which is not equal to a specified search element.
*
Expand Down Expand Up @@ -11119,6 +11301,37 @@ interface Namespace {
*/
srev: typeof srev;

/**
* Appends elements to a single-precision floating-point strided array by circularly repeating existing elements.
*
* @param N - number of indexed elements in `x`
* @param k - number of elements to pad
* @param x - input array
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - stride length for `y`
* @returns output array
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.srightPadCircular( x.length, 2, x, 1, y, 1 );
* // y => <Float32Array>[ 1.0, 2.0, 3.0, 1.0, 2.0 ]
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
* var y = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.srightPadCircular.ndarray( x.length, 2, x, 1, 0, y, 1, 0 );
* // y => <Float32Array>[ 1.0, 2.0, 3.0, 1.0, 2.0 ]
*/
srightPadCircular: typeof srightPadCircular;

/**
* Tests whether a single-precision floating-point strided array contains at least `k` truthy elements.
*
Expand Down Expand Up @@ -13285,6 +13498,40 @@ interface Namespace {
*/
zwhere: typeof zwhere;

/**
* 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 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( [ 4.0, 6.0, 12.0, 8.0, 16.0, 8.0 ] );
* var y = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0 ] );
* var w = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zwxdy( x.length, x, 1, y, 1, w, 1 );
* // w => <Complex128Array>[ 5.0, 1.0, 5.0, -1.0, 3.0, -1.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 4.0, 6.0, 12.0, 8.0, 16.0, 8.0 ] );
* var y = new Complex128Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0 ] );
* var w = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zwxdy.ndarray( x.length, x, 1, 0, y, 1, 0, w, 1, 0 );
* // w => <Complex128Array>[ 5.0, 1.0, 5.0, -1.0, 3.0, -1.0 ]
*/
zwxdy: typeof zwxdy;

/**
* Multiplies 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 elements in a double-precision complex floating-point strided array `w`.
*
Expand Down
Loading