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 b18ef1fd4161..c6f9e9ef05cd 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 @@ -27,6 +27,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 dscal = require( '@stdlib/blas/base/ndarray/dscal' ); import dswap = require( '@stdlib/blas/base/ndarray/dswap' ); import gasum = require( '@stdlib/blas/base/ndarray/gasum' ); import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' ); @@ -37,6 +38,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 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' ); @@ -108,7 +110,7 @@ interface Namespace { ccopy: typeof ccopy; /** - * Interchanges two one-dimensional single-precision complex floating-point ndarrays. + * Interchanges two one-dimensional complex single-precision floating-point ndarrays. * * ## Notes * @@ -241,6 +243,37 @@ interface Namespace { */ ddot: typeof ddot; + /** + * Multiplies a one-dimensional double-precision 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 Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * + * var alpha = scalar2ndarray( 5.0, { + * 'dtype': 'float64' + * }); + * + * var y = ns.dscal( [ x, alpha ] ); + * // returns [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + * + * var bool = ( y === x ); + * // returns true + */ + dscal: typeof dscal; + /** * Interchanges two one-dimensional double-precision floating-point ndarrays. * @@ -509,6 +542,37 @@ interface Namespace { */ sdot: typeof sdot; + /** + * Multiplies a one-dimensional single-precision 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 Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * + * var alpha = scalar2ndarray( 5.0, { + * 'dtype': 'float32' + * }); + * + * var y = ns.sscal( [ x, alpha ] ); + * // returns [ 5.0, 10.0, 15.0, 20.0, 25.0 ] + * + * var bool = ( y === x ); + * // returns true + */ + sscal: typeof sscal; + /** * Interchanges two one-dimensional single-precision floating-point ndarrays. * @@ -599,7 +663,7 @@ interface Namespace { zcopy: typeof zcopy; /** - * Interchanges two one-dimensional double-precision complex floating-point ndarrays. + * Interchanges two one-dimensional complex double-precision floating-point ndarrays. * * ## Notes *