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 4f192341f0f9..cab001ec0114 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 @@ -20,6 +20,7 @@ /* eslint-disable max-lines */ +import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' ); import dasum = require( '@stdlib/blas/base/ndarray/dasum' ); import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' ); import ddot = require( '@stdlib/blas/base/ndarray/ddot' ); @@ -29,11 +30,40 @@ 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' ); +import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' ); /** * Interface describing the `ndarray` namespace. */ interface Namespace { + /** + * Multiplies a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional single-precision complex 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 Complex64Array = require( '@stdlib/array/complex64' ); + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + * var x = new ndarray( 'complex64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * var y = new ndarray( 'complex64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var alpha = scalar2ndarray( new Complex64( 1.0, 2.0 ), 'complex64', 'row-major' ); + * + * var z = ns.caxpy( [ x, y, alpha ] ); + * // returns [ [ -2.0, 5.0 ], [ -4.0, 11.0 ], [ -6.0, 17.0 ], [ -8.0, 23.0 ], [ -10.0, 29.0 ] ] + * + * var bool = ( z === y ); + * // returns true + */ + caxpy: typeof caxpy; + /** * Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray. * @@ -228,6 +258,34 @@ interface Namespace { * // returns -5.0 */ sdot: typeof sdot; + + /** + * Multiplies a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision complex 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 Complex128Array = require( '@stdlib/array/complex128' ); + * var Complex128 = require( '@stdlib/complex/float64/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + * var x = new ndarray( 'complex128', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + * var y = new ndarray( 'complex128', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var alpha = scalar2ndarray( new Complex128( 1.0, 2.0 ), 'complex128', 'row-major' ); + * + * var z = ns.zaxpy( [ x, y, alpha ] ); + * // returns [ [ -2.0, 5.0 ], [ -4.0, 11.0 ], [ -6.0, 17.0 ], [ -8.0, 23.0 ], [ -10.0, 29.0 ] ] + * + * var bool = ( z === y ); + * // returns true + */ + zaxpy: typeof zaxpy; } /**