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
33 changes: 33 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 @@ -44,6 +44,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 zscal = require( '@stdlib/blas/base/ndarray/zscal' );
import zswap = require( '@stdlib/blas/base/ndarray/zswap' );

/**
Expand Down Expand Up @@ -727,6 +728,38 @@ interface Namespace {
*/
zcopy: typeof zcopy;

/**
* Multiplies a one-dimensional double-precision complex floating-point ndarray by a 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 Complex128 = require( '@stdlib/complex/float64/ctor' );
* 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( new Complex128( 2.0, 0.0 ), {
* 'dtype': 'complex128'
* });
*
* var y = ns.zscal( [ 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
*/
zscal: typeof zscal;

/**
* Interchanges two one-dimensional double-precision complex floating-point ndarrays.
*
Expand Down
Loading