Skip to content

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

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

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

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
250 changes: 250 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 @@ -41,6 +41,7 @@ import cwapx = require( '@stdlib/blas/ext/base/ndarray/cwapx' );
import cwax = require( '@stdlib/blas/ext/base/ndarray/cwax' );
import cwhere = require( '@stdlib/blas/ext/base/ndarray/cwhere' );
import cwxsa = require( '@stdlib/blas/ext/base/ndarray/cwxsa' );
import cxdy = require( '@stdlib/blas/ext/base/ndarray/cxdy' );
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 Down Expand Up @@ -108,7 +109,9 @@ import dvander = require( '@stdlib/blas/ext/base/ndarray/dvander' );
import dwapx = require( '@stdlib/blas/ext/base/ndarray/dwapx' );
import dwax = require( '@stdlib/blas/ext/base/ndarray/dwax' );
import dwhere = require( '@stdlib/blas/ext/base/ndarray/dwhere' );
import dwxpy = require( '@stdlib/blas/ext/base/ndarray/dwxpy' );
import dwxsa = require( '@stdlib/blas/ext/base/ndarray/dwxsa' );
import dwxsy = require( '@stdlib/blas/ext/base/ndarray/dwxsy' );
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 Down Expand Up @@ -186,9 +189,13 @@ import gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' );
import gvander = require( '@stdlib/blas/ext/base/ndarray/gvander' );
import gwapx = require( '@stdlib/blas/ext/base/ndarray/gwapx' );
import gwax = require( '@stdlib/blas/ext/base/ndarray/gwax' );
import gwaxpb = require( '@stdlib/blas/ext/base/ndarray/gwaxpb' );
import gwhere = require( '@stdlib/blas/ext/base/ndarray/gwhere' );
import gwxdy = require( '@stdlib/blas/ext/base/ndarray/gwxdy' );
import gwxmy = require( '@stdlib/blas/ext/base/ndarray/gwxmy' );
import gwxpy = require( '@stdlib/blas/ext/base/ndarray/gwxpy' );
import gwxsa = require( '@stdlib/blas/ext/base/ndarray/gwxsa' );
import gwxsy = require( '@stdlib/blas/ext/base/ndarray/gwxsy' );
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 @@ -249,7 +256,9 @@ import svander = require( '@stdlib/blas/ext/base/ndarray/svander' );
import swapx = require( '@stdlib/blas/ext/base/ndarray/swapx' );
import swax = require( '@stdlib/blas/ext/base/ndarray/swax' );
import swhere = require( '@stdlib/blas/ext/base/ndarray/swhere' );
import swxpy = require( '@stdlib/blas/ext/base/ndarray/swxpy' );
import swxsa = require( '@stdlib/blas/ext/base/ndarray/swxsa' );
import swxsy = require( '@stdlib/blas/ext/base/ndarray/swxsy' );
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 Down Expand Up @@ -969,6 +978,30 @@ interface Namespace {
*/
cwxsa: typeof cwxsa;

/**
* Divides 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.
*
* ## 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 Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
*
* var x = new Complex64Vector( [ -1.0, 3.0, -2.0, 14.0, -4.0, 44.0 ] );
* var y = new Complex64Vector( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0 ] );
*
* var out = ns.cxdy( [ x, y ] );
* // returns <ndarray>[ <Complex64>[ 1.0, 2.0 ], <Complex64>[ 3.0, 4.0 ], <Complex64>[ 5.0, 6.0 ] ]
*/
cxdy: typeof cxdy;

/**
* 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 @@ -3003,6 +3036,32 @@ interface Namespace {
*/
dwhere: typeof dwhere;

/**
* Adds elements of a one-dimensional double-precision floating-point ndarray to the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var w = new Float64Vector( 5 );
*
* var out = ns.dwxpy( [ x, y, w ] );
* // returns <ndarray>[ 3.0, 5.0, 7.0, 9.0, 11.0 ]
*/
dwxpy: typeof dwxpy;

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

/**
* Subtracts elements of a second one-dimensional double-precision floating-point ndarray from the corresponding elements of a first one-dimensional double-precision floating-point ndarray and assigns the results to elements in a third one-dimensional double-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ] );
* var w = new Float64Vector( 5 );
*
* var out = ns.dwxsy( [ x, y, w ] );
* // returns <ndarray>[ -4.0, -2.0, 0.0, 2.0, 4.0 ]
*/
dwxsy: typeof dwxsy;

/**
* 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 @@ -5437,6 +5522,41 @@ interface Namespace {
*/
gwax: typeof gwax;

/**
* Multiplies each element in an input one-dimensional ndarray by a scalar constant and adds a scalar constant before assigning 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 multiply.
* - a zero-dimensional ndarray containing the scalar constant to add.
*
* @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 beta = scalar2ndarray( 3.0, {
* 'dtype': 'generic'
* });
*
* var out = ns.gwaxpb( [ x, w, alpha, beta ] );
* // returns <ndarray>[ -7.0, 8.0, 18.0, -22.0 ]
*/
gwaxpb: typeof gwaxpb;

/**
* Takes elements from one of two one-dimensional ndarrays depending on a condition.
*
Expand Down Expand Up @@ -5465,6 +5585,58 @@ interface Namespace {
*/
gwhere: typeof gwhere;

/**
* Divides elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assigns the results to elements in a third one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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 w = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
*
* var out = ns.gwxdy( [ x, y, w ] );
* // returns <ndarray>[ 2.0, 2.0, 3.0, 4.0, 5.0 ]
*/
gwxdy: typeof gwxdy;

/**
* Multiplies elements of a one-dimensional ndarray by the corresponding elements of a second one-dimensional ndarray and assigns the results to elements in a third one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
* var y = vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ], 'generic' );
* var w = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
*
* var out = ns.gwxmy( [ x, y, w ] );
* // returns <ndarray>[ 2.0, 6.0, 12.0, 20.0, 30.0 ]
*/
gwxmy: typeof gwxmy;

/**
* Adds elements of a one-dimensional ndarray to the corresponding elements of a second one-dimensional ndarray and assigns the results to elements in a third one-dimensional ndarray.
*
Expand Down Expand Up @@ -5521,6 +5693,32 @@ interface Namespace {
*/
gwxsa: typeof gwxsa;

/**
* Subtracts elements of a second one-dimensional ndarray from the corresponding elements of a first one-dimensional ndarray and assigns the results to elements in a third one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
* var y = vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ], 'generic' );
* var w = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
*
* var out = ns.gwxsy( [ x, y, w ] );
* // returns <ndarray>[ -4.0, -2.0, 0.0, 2.0, 4.0 ]
*/
gwxsy: typeof gwxsy;

/**
* 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 @@ -7316,6 +7514,32 @@ interface Namespace {
*/
swhere: typeof swhere;

/**
* Adds elements of a one-dimensional single-precision floating-point ndarray to the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assigns the results to elements in a third one-dimensional single-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var w = new Float32Vector( 5 );
*
* var out = ns.swxpy( [ x, y, w ] );
* // returns <ndarray>[ 3.0, 5.0, 7.0, 9.0, 11.0 ]
*/
swxpy: typeof swxpy;

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

/**
* Subtracts elements of a second one-dimensional single-precision floating-point ndarray from the corresponding elements of a first one-dimensional single-precision floating-point ndarray and assigns the results to elements in a third one-dimensional single-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second 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( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Vector( [ 5.0, 4.0, 3.0, 2.0, 1.0 ] );
* var w = new Float32Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var out = ns.swxsy( [ x, y, w ] );
* // returns <ndarray>[ -4.0, -2.0, 0.0, 2.0, 4.0 ]
*/
swxsy: typeof swxsy;

/**
* 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
Loading