diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts index 8fa388538c7b..eda0ae63aff9 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts @@ -22,6 +22,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 cswap = require( '@stdlib/blas/base/ndarray/cswap' ); import dasum = require( '@stdlib/blas/base/ndarray/dasum' ); import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' ); @@ -33,6 +34,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 gscal = require( '@stdlib/blas/base/ndarray/gscal' ); import gswap = require( '@stdlib/blas/base/ndarray/gswap' ); import sasum = require( '@stdlib/blas/base/ndarray/sasum' ); import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' ); @@ -109,6 +111,38 @@ interface Namespace { */ ccopy: typeof ccopy; + /** + * Multiplies a one-dimensional single-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 Complex64Vector = require( '@stdlib/ndarray/vector/complex64' ); + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * 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( new Complex64( 2.0, 0.0 ), { + * 'dtype': 'complex64' + * }); + * + * var y = ns.cscal( [ x, alpha ] ); + * // returns [ [ 2.0, 4.0 ], [ 6.0, 8.0 ], [ 10.0, 12.0 ] ] + * + * var bool = ( y === x ); + * // returns true + */ + cscal: typeof cscal; + /** * Interchanges two one-dimensional single-precision complex floating-point ndarrays. * @@ -408,6 +442,37 @@ interface Namespace { */ gdot: typeof gdot; + /** + * Multiplies a one-dimensional 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 vector = require( '@stdlib/ndarray/vector/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' ); + * + * var alpha = scalar2ndarray( 5.0, { + * 'dtype': 'generic' + * }); + * + * var y = ns.gscal( [ x, alpha ] ); + * // returns [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + * + * var bool = ( y === x ); + * // returns true + */ + gscal: typeof gscal; + /** * Interchanges two one-dimensional ndarrays. *