Skip to content

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

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

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

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
147 changes: 147 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 @@ -210,9 +210,12 @@ import gfirstIndexGreaterThan = require( '@stdlib/blas/ext/base/gfirst-index-gre
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 gindexOfAlmostSameValue = require( '@stdlib/blas/ext/base/gindex-of-almost-same-value' );
import gindexOfColumn = require( '@stdlib/blas/ext/base/gindex-of-column' );
import gindexOfFalsy = require( '@stdlib/blas/ext/base/gindex-of-falsy' );
import gindexOfFalsyRow = require( '@stdlib/blas/ext/base/gindex-of-falsy-row' );
import gindexOfGreaterThanEqual = require( '@stdlib/blas/ext/base/gindex-of-greater-than-equal' );
import gindexOfLessThan = require( '@stdlib/blas/ext/base/gindex-of-less-than' );
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 @@ -391,6 +394,7 @@ import zindexOfRow = require( '@stdlib/blas/ext/base/zindex-of-row' );
import zindexOfTruthy = require( '@stdlib/blas/ext/base/zindex-of-truthy' );
import zlastIndexOfFalsy = require( '@stdlib/blas/ext/base/zlast-index-of-falsy' );
import zlastIndexOfRow = require( '@stdlib/blas/ext/base/zlast-index-of-row' );
import zlinspace = require( '@stdlib/blas/ext/base/zlinspace' );
import zlogspace = require( '@stdlib/blas/ext/base/zlogspace' );
import znancount = require( '@stdlib/blas/ext/base/znancount' );
import zoneTo = require( '@stdlib/blas/ext/base/zone-to' );
Expand Down Expand Up @@ -6262,6 +6266,34 @@ interface Namespace {
*/
gindexOf: typeof gindexOf;

/**
* Returns the index of the first element in a strided array which is almost 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 maxULP - maximum allowed ULP difference
* @param x - input array
* @param strideX - stride length
* @returns index
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
*
* var idx = ns.gindexOfAlmostSameValue( x.length, 2.0, 1, x, 1 );
* // returns 1
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
*
* var idx = ns.gindexOfAlmostSameValue.ndarray( x.length, 2.0, 1, x, 1, 0 );
* // returns 1
*/
gindexOfAlmostSameValue: typeof gindexOfAlmostSameValue;

/**
* Returns the index of the first column in an input matrix which has the same elements as a provided search vector.
*
Expand Down Expand Up @@ -6348,6 +6380,60 @@ interface Namespace {
*/
gindexOfFalsyRow: typeof gindexOfFalsyRow;

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

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

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

/**
* Fills a double-precision complex floating-point strided array with linearly spaced values over a specified interval.
*
* @param N - number of indexed elements
* @param start - start of interval
* @param stop - end of interval
* @param endpoint - boolean indicating whether to include the `stop` value when writing values to the input array
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var strt = new Complex128( 0.0, 0.0 );
* var stp = new Complex128( 4.0, 2.0 );
*
* ns.zlinspace( x.length, strt, stp, true, x, 1 );
* // x => <Complex128Array>[ 0.0, 0.0, 2.0, 1.0, 4.0, 2.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var strt = new Complex128( 0.0, 0.0 );
* var stp = new Complex128( 6.0, 3.0 );
*
* ns.zlinspace( x.length, strt, stp, false, x, 1 );
* // x => <Complex128Array>[ 0.0, 0.0, 2.0, 1.0, 4.0, 2.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var strt = new Complex128( 0.0, 0.0 );
* var stp = new Complex128( 4.0, 2.0 );
*
* ns.zlinspace.ndarray( x.length, strt, stp, true, x, 1, 0 );
* // x => <Complex128Array>[ 0.0, 0.0, 2.0, 1.0, 4.0, 2.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var strt = new Complex128( 0.0, 0.0 );
* var stp = new Complex128( 6.0, 3.0 );
*
* ns.zlinspace.ndarray( x.length, strt, stp, false, x, 1, 0 );
* // x => <Complex128Array>[ 0.0, 0.0, 2.0, 1.0, 4.0, 2.0 ]
*/
zlinspace: typeof zlinspace;

/**
* Fills a double-precision complex floating-point strided array with logarithmically spaced values over a specified interval.
*
Expand Down