diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts index 57ef86ebf5e1..2f3722af2359 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts @@ -20,6 +20,7 @@ /* eslint-disable max-lines */ +import cindexOf = require( '@stdlib/blas/ext/base/ndarray/cindex-of' ); import coneTo = require( '@stdlib/blas/ext/base/ndarray/cone-to' ); import csum = require( '@stdlib/blas/ext/base/ndarray/csum' ); import csumkbn = require( '@stdlib/blas/ext/base/ndarray/csumkbn' ); @@ -102,6 +103,7 @@ import ssumors = require( '@stdlib/blas/ext/base/ndarray/ssumors' ); import ssumpw = require( '@stdlib/blas/ext/base/ndarray/ssumpw' ); import sunitspace = require( '@stdlib/blas/ext/base/ndarray/sunitspace' ); import szeroTo = require( '@stdlib/blas/ext/base/ndarray/szero-to' ); +import zindexOf = require( '@stdlib/blas/ext/base/ndarray/zindex-of' ); import zoneTo = require( '@stdlib/blas/ext/base/ndarray/zone-to' ); import zsum = require( '@stdlib/blas/ext/base/ndarray/zsum' ); import zsumkbn = require( '@stdlib/blas/ext/base/ndarray/zsumkbn' ); @@ -112,6 +114,40 @@ import zzeroTo = require( '@stdlib/blas/ext/base/ndarray/zzero-to' ); * Interface describing the `ndarray` namespace. */ interface Namespace { + /** + * Returns the first index of a search element in a one-dimensional single-precision complex floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the search element. + * - a zero-dimensional ndarray containing the index from which to begin searching. + * + * @param arrays - array-like object containing ndarrays + * @returns index + * + * @example + * var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * + * var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * + * var searchElement = scalar2ndarray( new Complex64( 3.0, 4.0 ), { + * 'dtype': 'complex64' + * }); + * + * var fromIndex = scalar2ndarray( 0, { + * 'dtype': 'generic' + * }); + * + * var v = ns.cindexOf( [ x, searchElement, fromIndex ] ); + * // returns 1 + */ + cindexOf: typeof cindexOf; + /** * Fills a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one. * @@ -2334,6 +2370,40 @@ interface Namespace { */ szeroTo: typeof szeroTo; + /** + * Returns the first index of a search element in a one-dimensional double-precision complex floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the search element. + * - a zero-dimensional ndarray containing the index from which to begin searching. + * + * @param arrays - array-like object containing ndarrays + * @returns index + * + * @example + * var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var Complex128 = require( '@stdlib/complex/float64/ctor' ); + * + * var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * + * var searchElement = scalar2ndarray( new Complex128( 3.0, 4.0 ), { + * 'dtype': 'complex128' + * }); + * + * var fromIndex = scalar2ndarray( 0, { + * 'dtype': 'generic' + * }); + * + * var v = ns.zindexOf( [ x, searchElement, fromIndex ] ); + * // returns 1 + */ + zindexOf: typeof zindexOf; + /** * Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one. *