Skip to content

Commit 5f94431

Browse files
stdlib-botkgryte
andauthored
feat: update namespace TypeScript declarations
PR-URL: #2690 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 7d399c6 commit 5f94431

File tree

1 file changed

+34
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/docs/types

1 file changed

+34
-0
lines changed

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,46 @@
2020

2121
/* eslint-disable max-lines */
2222

23+
import dlacpy = require( '@stdlib/lapack/base/dlacpy' );
2324
import dlaswp = require( '@stdlib/lapack/base/dlaswp' );
2425

2526
/**
2627
* Interface describing the `base` namespace.
2728
*/
2829
interface Namespace {
30+
/**
31+
* Copies all or part of a matrix `A` to another matrix `B`.
32+
*
33+
* @param order - storage layout of `A` and `B`
34+
* @param uplo - specifies whether to copy the upper or lower triangular/trapezoidal part of matrix `A`
35+
* @param M - number of rows in matrix `A`
36+
* @param N - number of columns in matrix `A`
37+
* @param A - input matrix
38+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
39+
* @param B - output matrix
40+
* @param LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
41+
* @returns `B`
42+
*
43+
* @example
44+
* var Float64Array = require( '@stdlib/array/float64' );
45+
*
46+
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
47+
* var B = new Float64Array( 4 );
48+
*
49+
* ns.dlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
50+
* // B => <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
51+
*
52+
* @example
53+
* var Float64Array = require( '@stdlib/array/float64' );
54+
*
55+
* var A = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] );
56+
* var B = new Float64Array( [ 0.0, 0.0, 11.0, 312.0, 53.0, 412.0 ] );
57+
*
58+
* ns.dlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
59+
* // B => <Float64Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
60+
*/
61+
dlacpy: typeof dlacpy;
62+
2963
/**
3064
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
3165
*

0 commit comments

Comments
 (0)