Skip to content

feat: update blas/ext/base/ndarray TypeScript declarations #13572

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

feat: update blas/ext/base/ndarray TypeScript declarations #13572

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
215 changes: 215 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import cxpy = require( '@stdlib/blas/ext/base/ndarray/cxpy' );
import cxsa = require( '@stdlib/blas/ext/base/ndarray/cxsa' );
import cxsy = require( '@stdlib/blas/ext/base/ndarray/cxsy' );
import czeroTo = require( '@stdlib/blas/ext/base/ndarray/czero-to' );
import dany = require( '@stdlib/blas/ext/base/ndarray/dany' );
import daxpb = require( '@stdlib/blas/ext/base/ndarray/daxpb' );
import daxpby = require( '@stdlib/blas/ext/base/ndarray/daxpby' );
import dcircshift = require( '@stdlib/blas/ext/base/ndarray/dcircshift' );
Expand All @@ -41,6 +42,7 @@ import dcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dcusumkbn2' );
import dcusumors = require( '@stdlib/blas/ext/base/ndarray/dcusumors' );
import dcusumpw = require( '@stdlib/blas/ext/base/ndarray/dcusumpw' );
import ddiff = require( '@stdlib/blas/ext/base/ndarray/ddiff' );
import dfillEqual = require( '@stdlib/blas/ext/base/ndarray/dfill-equal' );
import dfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/dfill-not-equal' );
import dindexOf = require( '@stdlib/blas/ext/base/ndarray/dindex-of' );
import dindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/dindex-of-falsy' );
Expand All @@ -62,11 +64,13 @@ import dsumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dsumkbn2' );
import dsumors = require( '@stdlib/blas/ext/base/ndarray/dsumors' );
import dsumpw = require( '@stdlib/blas/ext/base/ndarray/dsumpw' );
import dunitspace = require( '@stdlib/blas/ext/base/ndarray/dunitspace' );
import dxdy = require( '@stdlib/blas/ext/base/ndarray/dxdy' );
import dxmy = require( '@stdlib/blas/ext/base/ndarray/dxmy' );
import dxpy = require( '@stdlib/blas/ext/base/ndarray/dxpy' );
import dxsa = require( '@stdlib/blas/ext/base/ndarray/dxsa' );
import dxsy = require( '@stdlib/blas/ext/base/ndarray/dxsy' );
import dzeroTo = require( '@stdlib/blas/ext/base/ndarray/dzero-to' );
import gany = require( '@stdlib/blas/ext/base/ndarray/gany' );
import gaxpb = require( '@stdlib/blas/ext/base/ndarray/gaxpb' );
import gaxpby = require( '@stdlib/blas/ext/base/ndarray/gaxpby' );
import gcircshift = require( '@stdlib/blas/ext/base/ndarray/gcircshift' );
Expand All @@ -80,6 +84,7 @@ import gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' );
import gfindLastIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-last-index' );
import gindexOf = require( '@stdlib/blas/ext/base/ndarray/gindex-of' );
import gindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/gindex-of-falsy' );
import gindexOfNotEqual = require( '@stdlib/blas/ext/base/ndarray/gindex-of-not-equal' );
import gindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/gindex-of-truthy' );
import gjoin = require( '@stdlib/blas/ext/base/ndarray/gjoin' );
import gjoinBetween = require( '@stdlib/blas/ext/base/ndarray/gjoin-between' );
Expand All @@ -99,11 +104,13 @@ import gsumkbn2 = require( '@stdlib/blas/ext/base/ndarray/gsumkbn2' );
import gsumors = require( '@stdlib/blas/ext/base/ndarray/gsumors' );
import gsumpw = require( '@stdlib/blas/ext/base/ndarray/gsumpw' );
import gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' );
import gxdy = require( '@stdlib/blas/ext/base/ndarray/gxdy' );
import gxmy = require( '@stdlib/blas/ext/base/ndarray/gxmy' );
import gxpy = require( '@stdlib/blas/ext/base/ndarray/gxpy' );
import gxsa = require( '@stdlib/blas/ext/base/ndarray/gxsa' );
import gxsy = require( '@stdlib/blas/ext/base/ndarray/gxsy' );
import gzeroTo = require( '@stdlib/blas/ext/base/ndarray/gzero-to' );
import sany = require( '@stdlib/blas/ext/base/ndarray/sany' );
import saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );
import saxpby = require( '@stdlib/blas/ext/base/ndarray/saxpby' );
import scircshift = require( '@stdlib/blas/ext/base/ndarray/scircshift' );
Expand All @@ -130,6 +137,7 @@ import ssumkbn2 = require( '@stdlib/blas/ext/base/ndarray/ssumkbn2' );
import ssumors = require( '@stdlib/blas/ext/base/ndarray/ssumors' );
import ssumpw = require( '@stdlib/blas/ext/base/ndarray/ssumpw' );
import sunitspace = require( '@stdlib/blas/ext/base/ndarray/sunitspace' );
import sxdy = require( '@stdlib/blas/ext/base/ndarray/sxdy' );
import sxmy = require( '@stdlib/blas/ext/base/ndarray/sxmy' );
import sxpy = require( '@stdlib/blas/ext/base/ndarray/sxpy' );
import sxsa = require( '@stdlib/blas/ext/base/ndarray/sxsa' );
Expand Down Expand Up @@ -474,6 +482,30 @@ interface Namespace {
*/
czeroTo: typeof czeroTo;

/**
* Tests whether at least one element in a one-dimensional double-precision floating-point ndarray is truthy.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* - The function explicitly treats `NaN` values as falsy.
*
* @param arrays - array-like object containing ndarrays
* @returns boolean indicating whether at least one element is truthy
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* var x = new Float64Vector( [ 0.0, 0.0, 1.0, 1.0 ] );
*
* var v = ns.dany( [ x ] );
* // returns true
*/
dany: typeof dany;

/**
* Multiplies each element in a one-dimensional double-precision floating-point ndarray by a scalar constant and adds a scalar constant to each result.
*
Expand Down Expand Up @@ -770,6 +802,41 @@ interface Namespace {
*/
ddiff: typeof ddiff;

/**
* Replaces elements in a one-dimensional double-precision floating-point ndarray equal to a provided search element with a specified scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the search element.
* - a zero-dimensional ndarray containing the scalar constant.
*
* - When comparing elements, the function checks for equality using the strict equality operator `===`. As a consequence, `NaN` values are considered distinct and `-0` and `+0` are considered the same.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float64Vector( [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] );
*
* var searchElement = scalar2ndarray( 0.0, {
* 'dtype': 'float64'
* });
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* var out = ns.dfillEqual( [ x, searchElement, alpha ] );
* // returns <ndarray>[ 5.0, -2.0, 3.0, 5.0, 4.0, -6.0 ]
*/
dfillEqual: typeof dfillEqual;

/**
* Replaces elements in a one-dimensional double-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.
*
Expand Down Expand Up @@ -1318,6 +1385,30 @@ interface Namespace {
*/
dunitspace: typeof dunitspace;

/**
* Divides elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to the second ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* var x = new Float64Vector( [ 6.0, 12.0, 20.0, 30.0, 42.0 ] );
* var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* var out = ns.dxdy( [ x, y ] );
* // returns <ndarray>[ 3.0, 4.0, 5.0, 6.0, 7.0 ]
*/
dxdy: typeof dxdy;

/**
* Multiplies elements of a one-dimensional double-precision floating-point ndarray by the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to the second ndarray.
*
Expand Down Expand Up @@ -1441,6 +1532,30 @@ interface Namespace {
*/
dzeroTo: typeof dzeroTo;

/**
* Tests whether at least one element in a one-dimensional ndarray is truthy.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* - The function explicitly treats `NaN` values as falsy.
*
* @param arrays - array-like object containing ndarrays
* @returns boolean indicating whether at least one element is truthy
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var x = vector( [ 0.0, 0.0, 1.0, 1.0 ], 'generic' );
*
* var v = ns.gany( [ x ] );
* // returns true
*/
gany: typeof gany;

/**
* Multiplies each element in a one-dimensional ndarray by a scalar constant and adds a scalar constant to each result.
*
Expand Down Expand Up @@ -1852,6 +1967,34 @@ interface Namespace {
*/
gindexOfFalsy: typeof gindexOfFalsy;

/**
* Returns the first index of an element in a one-dimensional ndarray which is not equal to a specified search element.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the search element.
*
* @param arrays - array-like object containing ndarrays
* @returns index
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = vector( [ 1.0, 1.0, 3.0 ], 'generic' );
*
* var searchElement = scalar2ndarray( 1.0, {
* 'dtype': 'generic'
* });
*
* var v = ns.gindexOfNotEqual( [ x, searchElement ] );
* // returns 2
*/
gindexOfNotEqual: typeof gindexOfNotEqual;

/**
* Returns the index of the first truthy element in a one-dimensional ndarray.
*
Expand Down Expand Up @@ -2335,6 +2478,30 @@ interface Namespace {
*/
gunitspace: typeof gunitspace;

/**
* Divides elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var x = vector( [ 4.0, 6.0, 12.0, 20.0, 30.0 ], 'generic' );
* var y = vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ], 'generic' );
*
* var out = ns.gxdy( [ x, y ] );
* // returns <ndarray>[ 2.0, 2.0, 3.0, 4.0, 5.0 ]
*/
gxdy: typeof gxdy;

/**
* Multiplies elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray.
*
Expand Down Expand Up @@ -2458,6 +2625,30 @@ interface Namespace {
*/
gzeroTo: typeof gzeroTo;

/**
* Tests whether at least one element in a one-dimensional single-precision floating-point ndarray is truthy.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* - The function explicitly treats `NaN` values as falsy.
*
* @param arrays - array-like object containing ndarrays
* @returns boolean indicating whether at least one element is truthy
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* var x = new Float32Vector( [ 0.0, 0.0, 1.0, 1.0 ] );
*
* var v = ns.sany( [ x ] );
* // returns true
*/
sany: typeof sany;

/**
* Multiplies each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and adds a scalar constant to each result.
*
Expand Down Expand Up @@ -3188,6 +3379,30 @@ interface Namespace {
*/
sunitspace: typeof sunitspace;

/**
* Divides elements of a one-dimensional single-precision floating-point ndarray by the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assigns the results to the second ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* var x = new Float32Vector( [ 10.0, 12.0, 6.0, -4.0, 8.0 ] );
* var y = new Float32Vector( [ 2.0, 3.0, 2.0, -2.0, 4.0 ] );
*
* var out = ns.sxdy( [ x, y ] );
* // returns <ndarray>[ 5.0, 4.0, 3.0, 2.0, 2.0 ]
*/
sxdy: typeof sxdy;

/**
* Multiplies elements of a one-dimensional single-precision floating-point ndarray by the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assigns the results to the second ndarray.
*
Expand Down