Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
/* eslint-disable max-lines */

import cfill = require( '@stdlib/blas/ext/base/cfill' );
import cindexOfRow = require( '@stdlib/blas/ext/base/cindex-of-row' );
import coneTo = require( '@stdlib/blas/ext/base/cone-to' );
import csum = require( '@stdlib/blas/ext/base/csum' );
import csumkbn = require( '@stdlib/blas/ext/base/csumkbn' );
import czeroTo = require( '@stdlib/blas/ext/base/czero-to' );
Expand Down Expand Up @@ -115,6 +117,7 @@ import gnansumkbn = require( '@stdlib/blas/ext/base/gnansumkbn' );
import gnansumkbn2 = require( '@stdlib/blas/ext/base/gnansumkbn2' );
import gnansumors = require( '@stdlib/blas/ext/base/gnansumors' );
import gnansumpw = require( '@stdlib/blas/ext/base/gnansumpw' );
import goneTo = require( '@stdlib/blas/ext/base/gone-to' );
import grev = require( '@stdlib/blas/ext/base/grev' );
import gsort = require( '@stdlib/blas/ext/base/gsort' );
import gsort2hp = require( '@stdlib/blas/ext/base/gsort2hp' );
Expand Down Expand Up @@ -176,6 +179,7 @@ import szeroTo = require( '@stdlib/blas/ext/base/szero-to' );
import wasm = require( '@stdlib/blas/ext/base/wasm' );
import zfill = require( '@stdlib/blas/ext/base/zfill' );
import zindexOfRow = require( '@stdlib/blas/ext/base/zindex-of-row' );
import zoneTo = require( '@stdlib/blas/ext/base/zone-to' );
import zsum = require( '@stdlib/blas/ext/base/zsum' );
import zsumkbn = require( '@stdlib/blas/ext/base/zsumkbn' );
import zzeroTo = require( '@stdlib/blas/ext/base/zzero-to' );
Expand Down Expand Up @@ -217,6 +221,75 @@ interface Namespace {
*/
cfill: typeof cfill;

/**
* 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.
*
* ## Notes
*
* - 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).
* - 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.
*
* @param order - storage layout
* @param M - number of rows in `A`
* @param N - number of columns in `A`
* @param A - input matrix
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param x - search vector
* @param strideX - stride length for `x`
* @param workspace - workspace array for tracking row match candidates
* @param strideW - stride length for `workspace`
* @returns row index
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Uint8Array = require( `@stdlib/array/uint8` );
*
* 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 ] );
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
* var workspace = new Uint8Array( 3 );
*
* var out = ns.cindexOfRow( 'column-major', 3, 2, A, 3, x, 1, workspace, 1 );
* // returns 1
*
* @example
* var Complex64Array = require( `@stdlib/array/complex64` );
* var Uint8Array = require( `@stdlib/array/uint8` );
*
* 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 ] );
* var x = new Complex64Array( [ 2.0, 0.0, 4.0, 0.0 ] );
* var workspace = new Uint8Array( 3 );
*
* var out = ns.cindexOfRow.ndarray( 3, 2, A, 1, 3, 0, x, 1, 0, workspace, 1, 0 );
* // returns 1
*/
cindexOfRow: typeof cindexOfRow;

/**
* Fills a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.coneTo( x.length, x, 1 );
* // x => <Complex64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var x = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.coneTo.ndarray( x.length, x, 1, 0 );
* // x => <Complex64Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
*/
coneTo: typeof coneTo;

/**
* Computes the sum of single-precision complex floating-point strided array elements.
*
Expand Down Expand Up @@ -2870,6 +2943,28 @@ interface Namespace {
*/
gnansumpw: typeof gnansumpw;

/**
* Fills a strided array with linearly spaced numeric elements which increment by `1` starting from one.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var x = [ 0.0, 0.0, 0.0, 0.0 ];
*
* ns.goneTo( x.length, x, 1 );
* // x => [ 1.0, 2.0, 3.0, 4.0 ]
*
* @example
* var x = [ 0.0, 0.0, 0.0, 0.0 ];
*
* ns.goneTo.ndarray( x.length, x, 1, 0 );
* // x => [ 1.0, 2.0, 3.0, 4.0 ]
*/
goneTo: typeof goneTo;

/**
* Reverses a strided array in-place.
*
Expand Down Expand Up @@ -4553,6 +4648,32 @@ interface Namespace {
*/
zindexOfRow: typeof zindexOfRow;

/**
* Fills a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zoneTo( x.length, x, 1 );
* // x => <Complex128Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.zoneTo.ndarray( x.length, x, 1, 0 );
* // x => <Complex128Array>[ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ]
*/
zoneTo: typeof zoneTo;

/**
* Computes the sum of double-precision complex floating-point strided array elements.
*
Expand Down