Skip to content

feat: update namespace TypeScript declarations #2591

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.

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
Jul 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 32 additions & 2 deletions lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,41 @@
import dlaswp = require( '@stdlib/lapack/base/dlaswp' );

/**
* Interface describing the `lapack` namespace.
* Interface describing the `base` namespace.
*/
interface Namespace {
/**
* TODO
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
*
* @param order - storage layout
* @param N - number of columns in `A`
* @param A - input matrix
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param k1 - index of first row to interchange
* @param k2 - index of last row to interchange
* @param IPIV - vector of pivot indices
* @param incx - increment between successive values of `IPIV`
* @returns permuted matrix `A`
*
* @example
* var Int32Array = require( '@stdlib/array/int32' );
* var Float64Array = require( '@stdlib/array/float64' );
*
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* ns.dlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, 1 );
* // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
*
* @example
* var Int32Array = require( '@stdlib/array/int32' );
* var Float64Array = require( '@stdlib/array/float64' );
*
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* ns.dlaswp.ndarray( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
* // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
*/
dlaswp: typeof dlaswp;
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/lapack/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import base = require( '@stdlib/lapack/base' );
*/
interface Namespace {
/**
* TODO
* Base (i.e., lower-level) LAPACK routines.
*/
base: typeof base;
}
Expand Down
Loading