|
23 | 23 | import dlaswp = require( '@stdlib/lapack/base/dlaswp' );
|
24 | 24 |
|
25 | 25 | /**
|
26 |
| -* Interface describing the `lapack` namespace. |
| 26 | +* Interface describing the `base` namespace. |
27 | 27 | */
|
28 | 28 | interface Namespace {
|
29 | 29 | /**
|
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 ] |
31 | 61 | */
|
32 | 62 | dlaswp: typeof dlaswp;
|
33 | 63 | }
|
|
0 commit comments