Skip to content

feat: update namespace TypeScript declarations #5938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2025
Merged

feat: update namespace TypeScript declarations #5938

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions lib/node_modules/@stdlib/blas/base/wasm/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' );
Expand Down Expand Up @@ -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 => <Float32Array>[ ~-17.0, 2.0, ~-18.0, 4.0, 5.0 ]
* // y => <Float32Array>[ ~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 => <Float32Array>[ ~-20.0, ~-25.0, 3.0, 4.0, 5.0 ]
* // y => <Float32Array>[ 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`.
*
Expand Down