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
32 changes: 32 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 @@ -23,6 +23,7 @@
import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
import ccopy = require( '@stdlib/blas/base/ndarray/ccopy' );
import cscal = require( '@stdlib/blas/base/ndarray/cscal' );
import csscal = require( '@stdlib/blas/base/ndarray/csscal' );
import cswap = require( '@stdlib/blas/base/ndarray/cswap' );
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
Expand Down Expand Up @@ -144,6 +145,37 @@ interface Namespace {
*/
cscal: typeof cscal;

/**
* Multiplies a one-dimensional single-precision complex floating-point ndarray by a single-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 Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* var alpha = scalar2ndarray( 2.0, {
* 'dtype': 'float32'
* });
*
* var y = ns.csscal( [ x, alpha ] );
* // returns <ndarray>[ <Complex64>[ 2.0, 4.0 ], <Complex64>[ 6.0, 8.0 ], <Complex64>[ 10.0, 12.0 ] ]
*
* var bool = ( y === x );
* // returns true
*/
csscal: typeof csscal;

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