Skip to content

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

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
Jul 7, 2026
+261 −0
Merged

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

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
261 changes: 261 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 @@ -66,6 +66,7 @@ import dcusumpw = require( '@stdlib/blas/ext/base/dcusumpw' );
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 dfillNaN = require( '@stdlib/blas/ext/base/dfill-nan' );
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' );
Expand Down Expand Up @@ -163,17 +164,24 @@ import gediff = require( '@stdlib/blas/ext/base/gediff' );
import gevery = require( '@stdlib/blas/ext/base/gevery' );
import gfill = require( '@stdlib/blas/ext/base/gfill' );
import gfillBy = require( '@stdlib/blas/ext/base/gfill-by' );
import gfillEqual = require( '@stdlib/blas/ext/base/gfill-equal' );
import gfillNaN = require( '@stdlib/blas/ext/base/gfill-nan' );
import gfindIndex = require( '@stdlib/blas/ext/base/gfind-index' );
import gfindLastIndex = require( '@stdlib/blas/ext/base/gfind-last-index' );
import gfirstIndexEqual = require( '@stdlib/blas/ext/base/gfirst-index-equal' );
import gfirstIndexGreaterThan = require( '@stdlib/blas/ext/base/gfirst-index-greater-than' );
import gfirstIndexLessThan = require( '@stdlib/blas/ext/base/gfirst-index-less-than' );
import gfirstIndexNotEqual = require( '@stdlib/blas/ext/base/gfirst-index-not-equal' );
import gindexOf = require( '@stdlib/blas/ext/base/gindex-of' );
import gindexOfColumn = require( '@stdlib/blas/ext/base/gindex-of-column' );
import gindexOfFalsy = require( '@stdlib/blas/ext/base/gindex-of-falsy' );
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' );
import gindexOfTruthy = require( '@stdlib/blas/ext/base/gindex-of-truthy' );
import gjoin = require( '@stdlib/blas/ext/base/gjoin' );
import gjoinBetween = require( '@stdlib/blas/ext/base/gjoin-between' );
import glastIndexEqual = require( '@stdlib/blas/ext/base/glast-index-equal' );
import glastIndexOf = require( '@stdlib/blas/ext/base/glast-index-of' );
import glastIndexOfFalsy = require( '@stdlib/blas/ext/base/glast-index-of-falsy' );
import glastIndexOfRow = require( '@stdlib/blas/ext/base/glast-index-of-row' );
Expand Down Expand Up @@ -255,6 +263,7 @@ import sdssum = require( '@stdlib/blas/ext/base/sdssum' );
import sdssumpw = require( '@stdlib/blas/ext/base/sdssumpw' );
import sediff = require( '@stdlib/blas/ext/base/sediff' );
import sfill = require( '@stdlib/blas/ext/base/sfill' );
import sfillNaN = require( '@stdlib/blas/ext/base/sfill-nan' );
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' );
Expand Down Expand Up @@ -1838,6 +1847,33 @@ interface Namespace {
*/
dfill: typeof dfill;

/**
* Replaces double-precision floating-point strided array elements equal to `NaN` with a specified scalar constant.
*
* @param N - number of indexed elements
* @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( [ NaN, 1.0, 3.0, NaN, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.dfillNaN( x.length, 0.0, x, 1 );
* // x => <Float64Array>[ 0.0, 1.0, 3.0, 0.0, 4.0, 0.0, -1.0, -3.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ NaN, 1.0, 3.0, NaN, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.dfillNaN.ndarray( x.length, 0.0, x, 1, 0 );
* // x => <Float64Array>[ 0.0, 1.0, 3.0, 0.0, 4.0, 0.0, -1.0, -3.0 ]
*/
dfillNaN: typeof dfillNaN;

/**
* Returns the first index of a specified search element in a double-precision floating-point strided array.
*
Expand Down Expand Up @@ -4669,6 +4705,30 @@ interface Namespace {
*/
gfillBy: typeof gfillBy;

/**
* Replaces 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 x = [ -2.0, 0.0, 3.0, 0.0, 4.0, 0.0, -1.0, -3.0 ];
*
* ns.gfillEqual( x.length, 0.0, 5.0, x, 1 );
* // x => [ -2.0, 5.0, 3.0, 5.0, 4.0, 5.0, -1.0, -3.0 ]
*
* @example
* var x = [ -2.0, 0.0, 3.0, 0.0, 4.0, 0.0, -1.0, -3.0 ];
*
* ns.gfillEqual.ndarray( x.length, 0.0, 5.0, x, 1, 0 );
* // x => [ -2.0, 5.0, 3.0, 5.0, 4.0, 5.0, -1.0, -3.0 ]
*/
gfillEqual: typeof gfillEqual;

/**
* Replaces strided array elements equal to `NaN` with a specified scalar constant.
*
Expand Down Expand Up @@ -4808,6 +4868,96 @@ interface Namespace {
*/
gfirstIndexEqual: typeof gfirstIndexEqual;

/**
* Returns the index of the first element in a strided array which is greater than a corresponding element in another strided array.
*
* ## Notes
*
* - If the function is unable to find an element in `x` which is greater than a corresponding element in `y`, 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 x = [ 1.0, 2.0, 3.0, 4.0 ];
* var y = [ 2.0, 2.0, 2.0, 2.0 ];
*
* var idx = ns.gfirstIndexGreaterThan( x.length, x, 1, y, 1 );
* // returns 2
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
* var y = [ 2.0, 2.0, 2.0, 2.0 ];
*
* var idx = ns.gfirstIndexGreaterThan.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 2
*/
gfirstIndexGreaterThan: typeof gfirstIndexGreaterThan;

/**
* Returns the index of the first element in a strided array which is less than a corresponding element in another strided array.
*
* ## Notes
*
* - If the function is unable to find an element in `x` which is less than a corresponding element in `y`, 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 x = [ 0.0, 0.0, 0.0, 0.0 ];
* var y = [ 0.0, 0.0, 1.0, 0.0 ];
*
* var idx = ns.gfirstIndexLessThan( x.length, x, 1, y, 1 );
* // returns 2
*
* @example
* var x = [ 0.0, 0.0, 0.0, 0.0 ];
* var y = [ 0.0, 0.0, 1.0, 0.0 ];
*
* var idx = ns.gfirstIndexLessThan.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 2
*/
gfirstIndexLessThan: typeof gfirstIndexLessThan;

/**
* Returns the index of the first element in a strided array which is not equal to the corresponding element in another strided array.
*
* ## Notes
*
* - If unable to find an element in `x` which is not equal to the corresponding element in `y`, 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 x = [ 0, 0, 1, 0 ];
* var y = [ 0, 0, 0, 0 ];
*
* var idx = ns.gfirstIndexNotEqual( x.length, x, 1, y, 1 );
* // returns 2
*
* @example
* var x = [ 0, 0, 1, 0 ];
* var y = [ 0, 0, 0, 0 ];
*
* var idx = ns.gfirstIndexNotEqual.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 2
*/
gfirstIndexNotEqual: typeof gfirstIndexNotEqual;

/**
* Returns the first index of a specified search element in a strided array.
*
Expand Down Expand Up @@ -4893,6 +5043,33 @@ interface Namespace {
*/
gindexOfFalsy: typeof gindexOfFalsy;

/**
* Returns the first index of an element in a strided array which is not equal to a specified search element.
*
* ## Notes
*
* - If all elements are 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 x = [ 1.0, 1.0, 0.0, 1.0 ];
*
* var idx = ns.gindexOfNotEqual( x.length, 1.0, x, 1 );
* // returns 2
*
* @example
* var x = [ 1.0, 1.0, 0.0, 1.0 ];
*
* var idx = ns.gindexOfNotEqual.ndarray( x.length, 1.0, x, 1, 0 );
* // returns 2
*/
gindexOfNotEqual: typeof gindexOfNotEqual;

/**
* Returns the index of the first row in an input matrix which has the same elements as a provided search vector.
*
Expand Down Expand Up @@ -4925,6 +5102,33 @@ interface Namespace {
*/
gindexOfRow: typeof gindexOfRow;

/**
* Returns the index of the first element in a strided array which has the same value as a provided search element.
*
* ## Notes
*
* - If the function is unable to find a 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 x = [ 1.0, 2.0, 3.0, 4.0 ];
*
* var idx = ns.gindexOfSameValue( x.length, 2.0, x, 1 );
* // returns 1
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
*
* var idx = ns.gindexOfSameValue.ndarray( x.length, 2.0, x, 1, 0 );
* // returns 1
*/
gindexOfSameValue: typeof gindexOfSameValue;

/**
* Returns the index of the first truthy element in a strided array.
*
Expand Down Expand Up @@ -5002,6 +5206,36 @@ interface Namespace {
*/
gjoinBetween: typeof gjoinBetween;

/**
* Returns the index of the last element in a strided array equal to a corresponding element in another 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 x = [ 1.0, 2.0, 3.0, 4.0 ];
* var y = [ 0.0, 0.0, 3.0, 0.0 ];
*
* var idx = ns.glastIndexEqual( x.length, x, 1, y, 1 );
* // returns 2
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
* var y = [ 0.0, 0.0, 3.0, 0.0 ];
*
* var idx = ns.glastIndexEqual.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 2
*/
glastIndexEqual: typeof glastIndexEqual;

/**
* Returns the last index of a specified search element in a strided array.
*
Expand Down Expand Up @@ -7241,6 +7475,33 @@ interface Namespace {
*/
sfill: typeof sfill;

/**
* Replaces single-precision floating-point strided array elements equal to `NaN` with a specified scalar constant.
*
* @param N - number of indexed elements
* @param alpha - scalar constant
* @param x - input array
* @param strideX - stride length
* @returns `x`
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ NaN, 1.0, 3.0, NaN, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.sfillNaN( x.length, 0.0, x, 1 );
* // x => <Float32Array>[ 0.0, 1.0, 3.0, 0.0, 4.0, 0.0, -1.0, -3.0 ]
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ NaN, 1.0, 3.0, NaN, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.sfillNaN.ndarray( x.length, 0.0, x, 1, 0 );
* // x => <Float32Array>[ 0.0, 1.0, 3.0, 0.0, 4.0, 0.0, -1.0, -3.0 ]
*/
sfillNaN: typeof sfillNaN;

/**
* Returns the first index of a specified search element in a single-precision floating-point strided array.
*
Expand Down