diff --git a/lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts index 9a5936fbff1e..2fe724726929 100644 --- a/lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts @@ -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 => [ 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 => [ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ] */ dlaswp: typeof dlaswp; } diff --git a/lib/node_modules/@stdlib/lapack/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/docs/types/index.d.ts index f5f6731972a1..ca07f05e5987 100644 --- a/lib/node_modules/@stdlib/lapack/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/lapack/docs/types/index.d.ts @@ -27,7 +27,7 @@ import base = require( '@stdlib/lapack/base' ); */ interface Namespace { /** - * TODO + * Base (i.e., lower-level) LAPACK routines. */ base: typeof base; }