Skip to content

Commit 7aaf16e

Browse files
committed
feat: update blas/ext/base TypeScript declarations
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 143bb4b commit 7aaf16e

File tree

1 file changed

+121
-0
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/docs/types

1 file changed

+121
-0
lines changed

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

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

2323
import cfill = require( '@stdlib/blas/ext/base/cfill' );
24+
import cindexOfRow = require( '@stdlib/blas/ext/base/cindex-of-row' );
25+
import coneTo = require( '@stdlib/blas/ext/base/cone-to' );
2426
import csum = require( '@stdlib/blas/ext/base/csum' );
2527
import csumkbn = require( '@stdlib/blas/ext/base/csumkbn' );
2628
import czeroTo = require( '@stdlib/blas/ext/base/czero-to' );
@@ -115,6 +117,7 @@ import gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' );
115117
import gnansumkbn2 = require( '@stdlib/blas/ext/base/gnansumkbn2' );
116118
import gnansumors = require( '@stdlib/blas/ext/base/gnansumors' );
117119
import gnansumpw = require( '@stdlib/blas/ext/base/gnansumpw' );
120+
import goneTo = require( '@stdlib/blas/ext/base/gone-to' );
118121
import grev = require( '@stdlib/blas/ext/base/grev' );
119122
import gsort = require( '@stdlib/blas/ext/base/gsort' );
120123
import gsort2hp = require( '@stdlib/blas/ext/base/gsort2hp' );
@@ -176,6 +179,7 @@ import szeroTo = require( '@stdlib/blas/ext/base/szero-to' );
176179
import wasm = require( '@stdlib/blas/ext/base/wasm' );
177180
import zfill = require( '@stdlib/blas/ext/base/zfill' );
178181
import zindexOfRow = require( '@stdlib/blas/ext/base/zindex-of-row' );
182+
import zoneTo = require( '@stdlib/blas/ext/base/zone-to' );
179183
import zsum = require( '@stdlib/blas/ext/base/zsum' );
180184
import zsumkbn = require( '@stdlib/blas/ext/base/zsumkbn' );
181185
import zzeroTo = require( '@stdlib/blas/ext/base/zzero-to' );
@@ -217,6 +221,75 @@ interface Namespace {
217221
*/
218222
cfill: typeof cfill;
219223

224+
/**
225+
* Returns the index of the first row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector.
226+
*
227+
* ## Notes
228+
*
229+
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
230+
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
231+
*
232+
* @param order - storage layout
233+
* @param M - number of rows in `A`
234+
* @param N - number of columns in `A`
235+
* @param A - input matrix
236+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
237+
* @param x - search vector
238+
* @param strideX - stride length for `x`
239+
* @param workspace - workspace array for tracking row match candidates
240+
* @param strideW - stride length for `workspace`
241+
* @returns row index
242+
*
243+
* @example
244+
* var Complex64Array = require( `@stdlib/array/complex64` );
245+
* var Uint8Array = require( `@stdlib/array/uint8` );
246+
*
247+
* var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
248+
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
249+
* var workspace = new Uint8Array( 3 );
250+
*
251+
* var out = ns.cindexOfRow( 'column-major', 3, 2, A, 3, x, 1, workspace, 1 );
252+
* // returns 1
253+
*
254+
* @example
255+
* var Complex64Array = require( `@stdlib/array/complex64` );
256+
* var Uint8Array = require( `@stdlib/array/uint8` );
257+
*
258+
* var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 0.0 ] );
259+
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
260+
* var workspace = new Uint8Array( 3 );
261+
*
262+
* var out = ns.cindexOfRow.ndarray( 3, 2, A, 1, 3, 0, x, 1, 0, workspace, 1, 0 );
263+
* // returns 1
264+
*/
265+
cindexOfRow: typeof cindexOfRow;
266+
267+
/**
268+
* Fills a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.
269+
*
270+
* @param N - number of indexed elements
271+
* @param x - input array
272+
* @param strideX - stride length
273+
* @returns input array
274+
*
275+
* @example
276+
* var Complex64Array = require( '@stdlib/array/complex64' );
277+
*
278+
* var x = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
279+
*
280+
* ns.coneTo( x.length, x, 1 );
281+
* // x => <Complex64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
282+
*
283+
* @example
284+
* var Complex64Array = require( '@stdlib/array/complex64' );
285+
*
286+
* var x = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
287+
*
288+
* ns.coneTo.ndarray( x.length, x, 1, 0 );
289+
* // x => <Complex64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
290+
*/
291+
coneTo: typeof coneTo;
292+
220293
/**
221294
* Computes the sum of single-precision complex floating-point strided array elements.
222295
*
@@ -2870,6 +2943,28 @@ interface Namespace {
28702943
*/
28712944
gnansumpw: typeof gnansumpw;
28722945

2946+
/**
2947+
* Fills a strided array with linearly spaced numeric elements which increment by `1` starting from one.
2948+
*
2949+
* @param N - number of indexed elements
2950+
* @param x - input array
2951+
* @param strideX - stride length
2952+
* @returns input array
2953+
*
2954+
* @example
2955+
* var x = [ 0.0, 0.0, 0.0, 0.0 ];
2956+
*
2957+
* ns.goneTo( x.length, x, 1 );
2958+
* // x => [ 1.0, 2.0, 3.0, 4.0 ]
2959+
*
2960+
* @example
2961+
* var x = [ 0.0, 0.0, 0.0, 0.0 ];
2962+
*
2963+
* ns.goneTo.ndarray( x.length, x, 1, 0 );
2964+
* // x => [ 1.0, 2.0, 3.0, 4.0 ]
2965+
*/
2966+
goneTo: typeof goneTo;
2967+
28732968
/**
28742969
* Reverses a strided array in-place.
28752970
*
@@ -4553,6 +4648,32 @@ interface Namespace {
45534648
*/
45544649
zindexOfRow: typeof zindexOfRow;
45554650

4651+
/**
4652+
* Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.
4653+
*
4654+
* @param N - number of indexed elements
4655+
* @param x - input array
4656+
* @param strideX - stride length
4657+
* @returns input array
4658+
*
4659+
* @example
4660+
* var Complex128Array = require( '@stdlib/array/complex128' );
4661+
*
4662+
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4663+
*
4664+
* ns.zoneTo( x.length, x, 1 );
4665+
* // x => <Complex128Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
4666+
*
4667+
* @example
4668+
* var Complex128Array = require( '@stdlib/array/complex128' );
4669+
*
4670+
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
4671+
*
4672+
* ns.zoneTo.ndarray( x.length, x, 1, 0 );
4673+
* // x => <Complex128Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
4674+
*/
4675+
zoneTo: typeof zoneTo;
4676+
45564677
/**
45574678
* Computes the sum of double-precision complex floating-point strided array elements.
45584679
*

0 commit comments

Comments
 (0)