From 2f0c47f15d6ef52026eefa9b55e6f1d2d17e15ba Mon Sep 17 00:00:00 2001 From: kgryte <2643044+kgryte@users.noreply.github.com> Date: Sun, 28 Jul 2024 11:31:38 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/lapack/base/docs/types/index.d.ts | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) 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 a017b5a920b0..366cf0731e87 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 @@ -20,12 +20,46 @@ /* eslint-disable max-lines */ +import dlacpy = require( '@stdlib/lapack/base/dlacpy' ); import dlaswp = require( '@stdlib/lapack/base/dlaswp' ); /** * Interface describing the `base` namespace. */ interface Namespace { + /** + * Copies all or part of a matrix `A` to another matrix `B`. + * + * @param order - storage layout of `A` and `B` + * @param uplo - specifies whether to copy the upper or lower triangular/trapezoidal part of matrix `A` + * @param M - number of rows in matrix `A` + * @param N - number of columns in matrix `A` + * @param A - input matrix + * @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) + * @param B - output matrix + * @param LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`) + * @returns `B` + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + * var B = new Float64Array( 4 ); + * + * ns.dlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 ); + * // B => [ 1.0, 2.0, 3.0, 4.0 ] + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var A = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] ); + * var B = new Float64Array( [ 0.0, 0.0, 11.0, 312.0, 53.0, 412.0 ] ); + * + * ns.dlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 ); + * // B => [ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ] + */ + dlacpy: typeof dlacpy; + /** * Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`. *