Skip to content

feat: update blas/base/ndarray TypeScript declarations #12415

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
Jun 1, 2026
+92 −0
Merged

feat: update blas/base/ndarray TypeScript declarations #12415

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
92 changes: 92 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import dnrm2 = require( '@stdlib/blas/base/ndarray/dnrm2' );
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
import dsdot = require( '@stdlib/blas/base/ndarray/dsdot' );
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
import dzasum = require( '@stdlib/blas/base/ndarray/dzasum' );
import dznrm2 = require( '@stdlib/blas/base/ndarray/dznrm2' );
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
Expand All @@ -41,6 +42,9 @@ import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
import gnrm2 = require( '@stdlib/blas/base/ndarray/gnrm2' );
import gscal = require( '@stdlib/blas/base/ndarray/gscal' );
import gswap = require( '@stdlib/blas/base/ndarray/gswap' );
import idamax = require( '@stdlib/blas/base/ndarray/idamax' );
import igamax = require( '@stdlib/blas/base/ndarray/igamax' );
import isamax = require( '@stdlib/blas/base/ndarray/isamax' );
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
import scasum = require( '@stdlib/blas/base/ndarray/scasum' );
Expand Down Expand Up @@ -424,6 +428,28 @@ interface Namespace {
*/
dswap: typeof dswap;

/**
* Computes the sum of absolute values for all elements in a one-dimensional double-precision complex floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns sum
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
*
* var x = new Complex128Vector( [ 1.0, -2.0, 3.0, -4.0 ] );
*
* var y = ns.dzasum( [ x ] );
* // returns 10.0
*/
dzasum: typeof dzasum;

/**
* Computes the L2-norm of a one-dimensional double-precision complex floating-point ndarray.
*
Expand Down Expand Up @@ -633,6 +659,72 @@ interface Namespace {
*/
gswap: typeof gswap;

/**
* Finds the index of the first element having the maximum absolute value for all elements in a one-dimensional double-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns index value
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* var x = new Float64Vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] );
*
* var y = ns.idamax( [ x ] );
* // returns 4.0
*/
idamax: typeof idamax;

/**
* Finds the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns index value
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var x = vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ], 'generic' );
*
* var y = ns.igamax( [ x ] );
* // returns 4
*/
igamax: typeof igamax;

/**
* Finds the index of the first element having the maximum absolute value for all elements in a one-dimensional single-precision floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns index value
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* var x = new Float32Vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] );
*
* var y = ns.isamax( [ x ] );
* // returns 4.0
*/
isamax: typeof isamax;

/**
* Computes the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.
*
Expand Down