Skip to content

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

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

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

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
240 changes: 240 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 @@ -27,6 +27,7 @@ import coneTo = require( '@stdlib/blas/ext/base/ndarray/cone-to' );
import csum = require( '@stdlib/blas/ext/base/ndarray/csum' );
import csumkbn = require( '@stdlib/blas/ext/base/ndarray/csumkbn' );
import cunitspace = require( '@stdlib/blas/ext/base/ndarray/cunitspace' );
import cwxsa = require( '@stdlib/blas/ext/base/ndarray/cwxsa' );
import cxmy = require( '@stdlib/blas/ext/base/ndarray/cxmy' );
import cxpy = require( '@stdlib/blas/ext/base/ndarray/cxpy' );
import cxsa = require( '@stdlib/blas/ext/base/ndarray/cxsa' );
Expand All @@ -44,8 +45,10 @@ 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 dfirstIndexLessThan = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-less-than' );
import dindexOf = require( '@stdlib/blas/ext/base/ndarray/dindex-of' );
import dindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/dindex-of-falsy' );
import dindexOfNotEqual = require( '@stdlib/blas/ext/base/ndarray/dindex-of-not-equal' );
import dlastIndexOf = require( '@stdlib/blas/ext/base/ndarray/dlast-index-of' );
import dlinspace = require( '@stdlib/blas/ext/base/ndarray/dlinspace' );
import dnansum = require( '@stdlib/blas/ext/base/ndarray/dnansum' );
Expand All @@ -64,6 +67,7 @@ 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 dwxsa = require( '@stdlib/blas/ext/base/ndarray/dwxsa' );
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' );
Expand All @@ -82,6 +86,7 @@ import gcusumpw = require( '@stdlib/blas/ext/base/ndarray/gcusumpw' );
import gfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-not-equal' );
import gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' );
import gfindLastIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-last-index' );
import gfirstIndexLessThan = require( '@stdlib/blas/ext/base/ndarray/gfirst-index-less-than' );
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' );
Expand All @@ -104,6 +109,7 @@ 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 gwxsa = require( '@stdlib/blas/ext/base/ndarray/gwxsa' );
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' );
Expand Down Expand Up @@ -137,6 +143,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 swxsa = require( '@stdlib/blas/ext/base/ndarray/swxsa' );
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' );
Expand All @@ -150,6 +157,7 @@ import zoneTo = require( '@stdlib/blas/ext/base/ndarray/zone-to' );
import zsum = require( '@stdlib/blas/ext/base/ndarray/zsum' );
import zsumkbn = require( '@stdlib/blas/ext/base/ndarray/zsumkbn' );
import zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' );
import zwxsa = require( '@stdlib/blas/ext/base/ndarray/zwxsa' );
import zxdy = require( '@stdlib/blas/ext/base/ndarray/zxdy' );
import zxmy = require( '@stdlib/blas/ext/base/ndarray/zxmy' );
import zxpy = require( '@stdlib/blas/ext/base/ndarray/zxpy' );
Expand Down Expand Up @@ -360,6 +368,37 @@ interface Namespace {
*/
cunitspace: typeof cunitspace;

/**
* Subtracts a scalar constant from each element in an input one-dimensional single-precision complex floating-point ndarray and assigns the results to elements in a one-dimensional single-precision complex floating-point output ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
* - a zero-dimensional ndarray containing the scalar constant to subtract.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Complex64Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
* var w = new Complex64Vector( 2 );
*
* var alpha = scalar2ndarray( new Complex64( 5.0, 0.0 ), {
* 'dtype': 'complex64'
* });
*
* var out = ns.cwxsa( [ x, w, alpha ] );
* // returns <ndarray>[ <Complex64>[ -7.0, 1.0 ], <Complex64>[ -2.0, -5.0 ] ]
*/
cwxsa: typeof cwxsa;

/**
* Multiplies elements of a one-dimensional single-precision complex floating-point ndarray by the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assigns the results to the second ndarray.
*
Expand Down Expand Up @@ -873,6 +912,32 @@ interface Namespace {
*/
dfillNotEqual: typeof dfillNotEqual;

/**
* Returns the index of the first element in a one-dimensional double-precision floating-point ndarray which is less than a corresponding element in another one-dimensional double-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
*
* - When comparing elements, the function checks whether an element in the first one-dimensional input ndarray is less than a corresponding element in the second one-dimensional input ndarray using the less-than operator `<`. As a consequence, comparisons involving `NaN` always evaluate to `false`.
*
* @param arrays - array-like object containing ndarrays
* @returns index
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* var x = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
* var y = new Float64Vector( [ 0.0, 0.0, 1.0, 0.0 ] );
*
* var idx = ns.dfirstIndexLessThan( [ x, y ] );
* // returns 2
*/
dfirstIndexLessThan: typeof dfirstIndexLessThan;

/**
* Returns the first index of a search element in a one-dimensional double-precision floating-point ndarray.
*
Expand Down Expand Up @@ -928,6 +993,34 @@ interface Namespace {
*/
dindexOfFalsy: typeof dindexOfFalsy;

/**
* Returns the first index of an element in a one-dimensional double-precision floating-point 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 Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float64Vector( [ 1.0, 1.0, 3.0 ] );
*
* var searchElement = scalar2ndarray( 1.0, {
* 'dtype': 'float64'
* });
*
* var v = ns.dindexOfNotEqual( [ x, searchElement ] );
* // returns 2
*/
dindexOfNotEqual: typeof dindexOfNotEqual;

/**
* Returns the last index of a search element in a one-dimensional double-precision floating-point ndarray.
*
Expand Down Expand Up @@ -1386,6 +1479,36 @@ interface Namespace {
*/
dunitspace: typeof dunitspace;

/**
* Subtracts a scalar constant from each element in an input one-dimensional double-precision floating-point ndarray and assigns the results to elements in a one-dimensional double-precision floating-point output ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
* - a zero-dimensional ndarray containing the scalar constant to subtract.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float64Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
* var w = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* var out = ns.dwxsa( [ x, w, alpha ] );
* // returns <ndarray>[ -7.0, -4.0, -2.0, -10.0 ]
*/
dwxsa: typeof dwxsa;

/**
* 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.
*
Expand Down Expand Up @@ -1913,6 +2036,32 @@ interface Namespace {
*/
gfindLastIndex: typeof gfindLastIndex;

/**
* Returns the index of the first element in a one-dimensional ndarray which is less than a corresponding element in another one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
*
* - When comparing elements, the function checks whether an element in the first one-dimensional input ndarray is less than a corresponding element in the second one-dimensional input ndarray using the less-than operator `<`. As a consequence, comparisons involving `NaN` always evaluate to `false`.
*
* @param arrays - array-like object containing ndarrays
* @returns index
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var x = vector( [ 0.0, 0.0, 0.0, 0.0 ], 'generic' );
* var y = vector( [ 0.0, 0.0, 1.0, 0.0 ], 'generic' );
*
* var idx = ns.gfirstIndexLessThan( [ x, y ] );
* // returns 2
*/
gfirstIndexLessThan: typeof gfirstIndexLessThan;

/**
* Returns the first index of a search element in a one-dimensional ndarray.
*
Expand Down Expand Up @@ -2479,6 +2628,36 @@ interface Namespace {
*/
gunitspace: typeof gunitspace;

/**
* Subtracts a scalar constant from each element in an input one-dimensional ndarray and assigns the results to elements in a one-dimensional output ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
* - a zero-dimensional ndarray containing the scalar constant to subtract.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = vector( [ -2.0, 1.0, 3.0, -5.0 ], 'generic' );
* var w = vector( [ 0.0, 0.0, 0.0, 0.0 ], 'generic' );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'generic'
* });
*
* var out = ns.gwxsa( [ x, w, alpha ] );
* // returns <ndarray>[ -7.0, -4.0, -2.0, -10.0 ]
*/
gwxsa: typeof gwxsa;

/**
* 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.
*
Expand Down Expand Up @@ -3380,6 +3559,36 @@ interface Namespace {
*/
sunitspace: typeof sunitspace;

/**
* Subtracts a scalar constant from each element in an input one-dimensional single-precision floating-point ndarray and assigns the results to elements in a one-dimensional single-precision floating-point output ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
* - a zero-dimensional ndarray containing the scalar constant to subtract.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
* var w = new Float32Vector( [ 0.0, 0.0, 0.0, 0.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float32'
* });
*
* var out = ns.swxsa( [ x, w, alpha ] );
* // returns <ndarray>[ -7.0, -4.0, -2.0, -10.0 ]
*/
swxsa: typeof swxsa;

/**
* 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.
*
Expand Down Expand Up @@ -3726,6 +3935,37 @@ interface Namespace {
*/
zunitspace: typeof zunitspace;

/**
* Subtracts a scalar constant from each element in an input one-dimensional double-precision complex floating-point ndarray and assigns the results to elements in a one-dimensional double-precision complex floating-point output ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a one-dimensional output ndarray.
* - a zero-dimensional ndarray containing the scalar constant to subtract.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Complex128Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
* var w = new Complex128Vector( 2 );
*
* var alpha = scalar2ndarray( new Complex128( 5.0, 0.0 ), {
* 'dtype': 'complex128'
* });
*
* var out = ns.zwxsa( [ x, w, alpha ] );
* // returns <ndarray>[ <Complex128>[ -7.0, 1.0 ], <Complex128>[ -2.0, -5.0 ] ]
*/
zwxsa: typeof zwxsa;

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