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 db43a8ae4b05..401c19cb0f6f 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 @@ -21,10 +21,12 @@ /* eslint-disable max-lines */ import dasum = require( '@stdlib/blas/base/ndarray/dasum' ); +import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' ); import ddot = require( '@stdlib/blas/base/ndarray/ddot' ); import gasum = require( '@stdlib/blas/base/ndarray/gasum' ); import gdot = require( '@stdlib/blas/base/ndarray/gdot' ); import sasum = require( '@stdlib/blas/base/ndarray/sasum' ); +import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' ); import sdot = require( '@stdlib/blas/base/ndarray/sdot' ); /** @@ -49,6 +51,33 @@ interface Namespace { */ dasum: typeof dasum; + /** + * Multiplies a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision floating-point ndarray `y`. + * + * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * @returns output ndarray + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var alpha = scalar2ndarray( 5.0, 'float64', 'row-major' ); + * + * var z = ns.daxpy( [ x, y, alpha ] ); + * // returns [ 6.0, 11.0, 16.0, 21.0, 26.0 ] + * + * var bool = ( z === y ); + * // returns true + */ + daxpy: typeof daxpy; + /** * Computes the dot product of two one-dimensional double-precision floating-point ndarrays. * @@ -125,6 +154,33 @@ interface Namespace { */ sasum: typeof sasum; + /** + * Multiplies a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional single-precision floating-point ndarray `y`. + * + * @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant + * @returns output ndarray + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * var y = new ndarray( 'float32', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var alpha = scalar2ndarray( 5.0, 'float32', 'row-major' ); + * + * var z = ns.saxpy( [ x, y, alpha ] ); + * // returns [ 6.0, 11.0, 16.0, 21.0, 26.0 ] + * + * var bool = ( z === y ); + * // returns true + */ + saxpy: typeof saxpy; + /** * Computes the dot product of two one-dimensional single-precision floating-point ndarrays. *