Skip to content

Commit 0b89aa1

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

File tree

1 file changed

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

1 file changed

+30
-0
lines changed

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
/* eslint-disable max-lines */
2222

2323
import dlacpy = require( '@stdlib/lapack/base/dlacpy' );
24+
import dlassq = require( '@stdlib/lapack/base/dlassq' );
2425
import dlaswp = require( '@stdlib/lapack/base/dlaswp' );
2526
import dpttrf = require( '@stdlib/lapack/base/dpttrf' );
2627

@@ -61,6 +62,35 @@ interface Namespace {
6162
*/
6263
dlacpy: typeof dlacpy;
6364

65+
/**
66+
* Returns an updated sum of squares represented in scaled form.
67+
*
68+
* @param N - number of indexed elements
69+
* @param X - input array
70+
* @param strideX - stride length for `X`
71+
* @param scale - scaling factor
72+
* @param sumsq - basic sum of squares from which output is factored out
73+
* @returns output array
74+
*
75+
* @example
76+
* var Float64Array = require( '@stdlib/array/float64' );
77+
*
78+
* var X = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
79+
*
80+
* var out = ns.dlassq( 4, X, 1, 1.0, 0.0, out );
81+
* // returns <Float64Array>[ 1.0, 30.0 ]
82+
*
83+
* @example
84+
* var Float64Array = require( '@stdlib/array/float64' );
85+
*
86+
* var X = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
87+
* var out = new Float64Array( [ 0.0, 0.0 ] );
88+
*
89+
* ns.dlassq.ndarray( 4, X, 1, 0, 1.0, 0.0, out, 1, 0 );
90+
* // out => <Float64Array>[ 1.0, 30.0 ]
91+
*/
92+
dlassq: typeof dlassq;
93+
6494
/**
6595
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
6696
*

0 commit comments

Comments
 (0)