Skip to content
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
import snrm2 = require( '@stdlib/blas/base/ndarray/snrm2' );
import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
Expand Down Expand Up @@ -664,6 +665,28 @@ interface Namespace {
*/
sdot: typeof sdot;

/**
* Computes the L2-norm of 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 L2-norm
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* var x = new Float32Vector( [ 1.0, -2.0, 2.0 ] );
*
* var y = ns.snrm2( [ x ] );
* // returns 3.0
*/
snrm2: typeof snrm2;

/**
* Multiplies a one-dimensional single-precision floating-point ndarray by a scalar constant.
*
Expand Down