From d46f683d28a3cc058941cc6b97212edfe743fa47 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 10 Mar 2025 02:38:00 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../blas/base/wasm/docs/types/index.d.ts | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/base/wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/wasm/docs/types/index.d.ts index dc7e7ff1c5ab..cbcb7be64697 100644 --- a/lib/node_modules/@stdlib/blas/base/wasm/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/wasm/docs/types/index.d.ts @@ -41,6 +41,7 @@ import scopy = require( '@stdlib/blas/base/scopy' ); import sdot = require( '@stdlib/blas/base/sdot' ); import snrm2 = require( '@stdlib/blas/base/snrm2' ); import srot = require( '@stdlib/blas/base/srot' ); +import srotm = require( '@stdlib/blas/base/srotm' ); import sscal = require( '@stdlib/blas/base/sscal' ); import zcopy = require( '@stdlib/blas/base/zcopy' ); import zdrot = require( '@stdlib/blas/base/zdrot' ); @@ -677,6 +678,41 @@ interface Namespace { */ srot: typeof srot; + /** + * Applies a modified Givens plane rotation. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param y - second input array + * @param strideY - `y` stride length + * @param param - parameters for the modified Givens transformation + * @returns `y` + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float32Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + * var param = new Float32Array( [ 0.0, 0.0, 2.0, -3.0, 0.0 ] ); + * + * ns.srotm( 2, x, 2, y, 1, param ); + * // x => [ ~-17.0, 2.0, ~-18.0, 4.0, 5.0 ] + * // y => [ ~8.0, ~13.0, 8.0, 9.0, 10.0 ] + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + * var y = new Float32Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + * var param = new Float32Array( [ 0.0, 0.0, 2.0, -3.0, 0.0 ] ); + * + * ns.srotm.ndarray( 2, x, 1, 0, y, 2, 1, param ); + * // x => [ ~-20.0, ~-25.0, 3.0, 4.0, 5.0 ] + * // y => [ 6.0, ~9.0, 8.0, ~13.0, 10.0 ] + */ + srotm: typeof srotm; + /** * Multiplies a single-precision floating-point vector `x` by a constant `alpha`. *