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 f5232ebb360b..26894a64a331 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 cgemv = require( '@stdlib/blas/base/ndarray/cgemv' ); import cscal = require( '@stdlib/blas/base/ndarray/cscal' ); import csscal = require( '@stdlib/blas/base/ndarray/csscal' ); import cswap = require( '@stdlib/blas/base/ndarray/cswap' ); @@ -126,6 +127,52 @@ interface Namespace { */ ccopy: typeof ccopy; + /** + * Performs one of the matrix-vector operations `y = alpha*A*x + beta*y`, `y = alpha*A^T*x + beta*y`, or `y = alpha*A^H*x + beta*y`, where `alpha` and `beta` are scalars, `x` and `y` are one-dimensional ndarrays, and `A` is an `M` by `N` matrix. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a two-dimensional input ndarray corresponding to `A`. + * - a one-dimensional input ndarray corresponding to `x`. + * - a one-dimensional input/output ndarray corresponding to `y`. + * - a zero-dimensional ndarray specifying whether `A` should be transposed, conjugate-transposed, or not transposed. + * - a zero-dimensional ndarray containing a scalar constant corresponding to `alpha`. + * - a zero-dimensional ndarray containing a scalar constant corresponding to `beta`. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var Complex64Matrix = require( '@stdlib/ndarray/matrix/complex64' ); + * var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' ); + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var resolveEnum = require( '@stdlib/blas/base/transpose-operation-resolve-enum' ); + * + * var A = new Complex64Matrix( [ [ 1.0, 2.0, 3.0, 4.0 ], [ 5.0, 6.0, 7.0, 8.0 ] ] ); + * var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); + * var y = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); + * + * var trans = scalar2ndarray( resolveEnum( 'no-transpose' ), { + * 'dtype': 'int8' + * }); + * var alpha = scalar2ndarray( new Complex64( 1.0, 0.0 ), { + * 'dtype': 'complex64' + * }); + * var beta = scalar2ndarray( new Complex64( 1.0, 0.0 ), { + * 'dtype': 'complex64' + * }); + * + * var z = ns.cgemv( [ A, x, y, trans, alpha, beta ] ); + * // returns [ [ -9.0, 30.0 ], [ -15.0, 72.0 ] ] + * + * var bool = ( z === y ); + * // returns true + */ + cgemv: typeof cgemv; + /** * Multiplies a one-dimensional single-precision complex floating-point ndarray by a scalar constant. *