Skip to content

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

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
May 20, 2026
+23 −0
Merged

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

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
23 changes: 23 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 @@ -36,6 +36,7 @@ import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
import gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
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 sasum = require( '@stdlib/blas/base/ndarray/sasum' );
Expand Down Expand Up @@ -500,6 +501,28 @@ interface Namespace {
*/
gdot: typeof gdot;

/**
* Computes the L2-norm of a one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns L2-norm
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var x = vector( [ 1.0, -2.0, 2.0 ], 'generic' );
*
* var y = ns.gnrm2( [ x ] );
* // returns 3.0
*/
gnrm2: typeof gnrm2;

/**
* Multiplies a one-dimensional ndarray by a scalar constant.
*
Expand Down