Skip to content

Commit e764597

Browse files
authored
feat: update blas/base TypeScript declarations
PR-URL: #11711 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 11fe978 commit e764597

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/blas/base/docs/types

lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import assert = require( '@stdlib/blas/base/assert' );
2424
import caxpy = require( '@stdlib/blas/base/caxpy' );
2525
import ccopy = require( '@stdlib/blas/base/ccopy' );
26+
import cgemv = require( '@stdlib/blas/base/cgemv' );
2627
import cscal = require( '@stdlib/blas/base/cscal' );
2728
import csrot = require( '@stdlib/blas/base/csrot' );
2829
import csscal = require( '@stdlib/blas/base/csscal' );
@@ -200,6 +201,51 @@ interface Namespace {
200201
*/
201202
ccopy: typeof ccopy;
202203

204+
/**
205+
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y` or `y = α*A^H*x + β*y`, where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
206+
*
207+
* @param order - storage layout
208+
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
209+
* @param M - number of rows in the matrix `A`
210+
* @param N - number of columns in the matrix `A`
211+
* @param alpha - scalar constant
212+
* @param A - input matrix
213+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
214+
* @param x - first input vector
215+
* @param strideX - `x` stride length
216+
* @param beta - scalar constant
217+
* @param y - second input vector
218+
* @param strideY - `y` stride length
219+
* @returns `y`
220+
*
221+
* @example
222+
* var Complex64Array = require( '@stdlib/array/complex64' );
223+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
224+
*
225+
* var A = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0 ] );
226+
* var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0 ] );
227+
* var y = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0 ] );
228+
* var alpha = new Complex64( 0.5, 0.5 );
229+
* var beta = new Complex64( 0.5, -0.5 );
230+
*
231+
* ns.cgemv( 'column-major', 'no-transpose', 4, 2, alpha, A, 4, x, 1, beta, y, 1 );
232+
* // y => <Complex64Array>[ -10.0, 11.0, -12.0, 14.0, -14.0, 17.0, -16.0, 20.0 ]
233+
*
234+
* @example
235+
* var Complex64Array = require( '@stdlib/array/complex64' );
236+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
237+
*
238+
* var A = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0 ] );
239+
* var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0 ] );
240+
* var y = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0 ] );
241+
* var alpha = new Complex64( 0.5, 0.5 );
242+
* var beta = new Complex64( 0.5, -0.5 );
243+
*
244+
* ns.cgemv.ndarray( 'no-transpose', 4, 2, alpha, A, 1, 4, 0, x, 1, 0, beta, y, 1, 0 );
245+
* // y => <Complex64Array>[ -10.0, 11.0, -12.0, 14.0, -14.0, 17.0, -16.0, 20.0 ]
246+
*/
247+
cgemv: typeof cgemv;
248+
203249
/**
204250
* Scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.
205251
*

0 commit comments

Comments
 (0)