Skip to content

Commit 82d3d97

Browse files
stdlib-botkgryte
andauthored
feat: update namespace TypeScript declarations
PR-URL: #2697 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
1 parent 4569092 commit 82d3d97

File tree

1 file changed

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

1 file changed

+31
-0
lines changed

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

+31
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import dlacpy = require( '@stdlib/lapack/base/dlacpy' );
2424
import dlaswp = require( '@stdlib/lapack/base/dlaswp' );
25+
import dpttrf = require( '@stdlib/lapack/base/dpttrf' );
2526

2627
/**
2728
* Interface describing the `base` namespace.
@@ -94,6 +95,36 @@ interface Namespace {
9495
* // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
9596
*/
9697
dlaswp: typeof dlaswp;
98+
99+
/**
100+
* Computes the `L * D * L^T` factorization of a real symmetric positive definite tridiagonal matrix `A`.
101+
*
102+
* @param N - order of matrix `A`
103+
* @param D - the `N` diagonal elements of `A`
104+
* @param E - the `N-1` subdiagonal elements of `A`
105+
* @returns status code
106+
*
107+
* @example
108+
* var Float64Array = require( '@stdlib/array/float64' );
109+
*
110+
* var D = new Float64Array( [ 4.0, 5.0, 6.0 ] );
111+
* var E = new Float64Array( [ 1.0, 2.0 ] );
112+
*
113+
* ns.dpttrf( 3, D, E );
114+
* // D => <Float64Array>[ 4, 4.75, ~5.15789 ]
115+
* // E => <Float64Array>[ 0.25, ~0.4210 ]
116+
*
117+
* @example
118+
* var Float64Array = require( '@stdlib/array/float64' );
119+
*
120+
* var D = new Float64Array( [ 4.0, 5.0, 6.0 ] );
121+
* var E = new Float64Array( [ 1.0, 2.0 ] );
122+
*
123+
* ns.dpttrf.ndarray( 3, D, 1, 0, E, 1, 0 );
124+
* // D => <Float64Array>[ 4, 4.75, ~5.15789 ]
125+
* // E => <Float64Array>[ 0.25, ~0.4210 ]
126+
*/
127+
dpttrf: typeof dpttrf;
97128
}
98129

99130
/**

0 commit comments

Comments
 (0)