Skip to content

Commit 86ce889

Browse files
stdlib-botkgryte
andauthored
feat: update namespace TypeScript declarations
PR-URL: #2591 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 6a106fb commit 86ce889

File tree

2 files changed

+33
-3
lines changed

2 files changed

+33
-3
lines changed

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

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,41 @@
2323
import dlaswp = require( '@stdlib/lapack/base/dlaswp' );
2424

2525
/**
26-
* Interface describing the `lapack` namespace.
26+
* Interface describing the `base` namespace.
2727
*/
2828
interface Namespace {
2929
/**
30-
* TODO
30+
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
31+
*
32+
* @param order - storage layout
33+
* @param N - number of columns in `A`
34+
* @param A - input matrix
35+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
36+
* @param k1 - index of first row to interchange
37+
* @param k2 - index of last row to interchange
38+
* @param IPIV - vector of pivot indices
39+
* @param incx - increment between successive values of `IPIV`
40+
* @returns permuted matrix `A`
41+
*
42+
* @example
43+
* var Int32Array = require( '@stdlib/array/int32' );
44+
* var Float64Array = require( '@stdlib/array/float64' );
45+
*
46+
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
47+
* 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 ] ]
48+
*
49+
* ns.dlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, 1 );
50+
* // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
51+
*
52+
* @example
53+
* var Int32Array = require( '@stdlib/array/int32' );
54+
* var Float64Array = require( '@stdlib/array/float64' );
55+
*
56+
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
57+
* 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 ] ]
58+
*
59+
* ns.dlaswp.ndarray( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
60+
* // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
3161
*/
3262
dlaswp: typeof dlaswp;
3363
}

lib/node_modules/@stdlib/lapack/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import base = require( '@stdlib/lapack/base' );
2727
*/
2828
interface Namespace {
2929
/**
30-
* TODO
30+
* Base (i.e., lower-level) LAPACK routines.
3131
*/
3232
base: typeof base;
3333
}

0 commit comments

Comments
 (0)