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
55 changes: 55 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 @@ -29,6 +29,7 @@ import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
import dnrm2 = require( '@stdlib/blas/base/ndarray/dnrm2' );
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
Expand All @@ -45,6 +46,7 @@ import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
import zcopy = require( '@stdlib/blas/base/ndarray/zcopy' );
import zdscal = require( '@stdlib/blas/base/ndarray/zdscal' );
import zscal = require( '@stdlib/blas/base/ndarray/zscal' );
import zswap = require( '@stdlib/blas/base/ndarray/zswap' );

Expand Down Expand Up @@ -310,6 +312,28 @@ interface Namespace {
*/
ddot: typeof ddot;

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

/**
* Multiplies a one-dimensional double-precision floating-point ndarray by a scalar constant.
*
Expand Down Expand Up @@ -760,6 +784,37 @@ interface Namespace {
*/
zcopy: typeof zcopy;

/**
* Multiplies a one-dimensional double-precision complex floating-point ndarray by a double-precision floating-point scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing a scalar constant.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* var alpha = scalar2ndarray( 2.0, {
* 'dtype': 'float64'
* });
*
* var y = ns.zdscal( [ x, alpha ] );
* // returns <ndarray>[ <Complex128>[ 2.0, 4.0 ], <Complex128>[ 6.0, 8.0 ], <Complex128>[ 10.0, 12.0 ] ]
*
* var bool = ( y === x );
* // returns true
*/
zdscal: typeof zdscal;

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