From 42f4fd96f9afba775be8f233e0b520870142eae7 Mon Sep 17 00:00:00 2001 From: kgryte Date: Wed, 20 Dec 2023 06:37:25 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations --- .../@stdlib/array/base/docs/types/index.d.ts | 63 +++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts index 850468317e5..468cdddc2cc 100644 --- a/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/docs/types/index.d.ts @@ -79,7 +79,9 @@ import flipud2d = require( '@stdlib/array/base/flipud2d' ); import strided2array = require( '@stdlib/array/base/from-strided' ); import getter = require( '@stdlib/array/base/getter' ); import incrspace = require( '@stdlib/array/base/incrspace' ); +import indexOf = require( '@stdlib/array/base/index-of' ); import last = require( '@stdlib/array/base/last' ); +import lastIndexOf = require( '@stdlib/array/base/last-index-of' ); import linspace = require( '@stdlib/array/base/linspace' ); import logspace = require( '@stdlib/array/base/logspace' ); import map2d = require( '@stdlib/array/base/map2d' ); @@ -1612,6 +1614,36 @@ interface Namespace { */ incrspace: typeof incrspace; + /** + * Returns the index of the first element which equals a provided search element. + * + * ## Notes + * + * - If unable to find an element which equals a provided search element, the function returns `-1`. + * - If `fromIndex` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `fromIndex = -1`. + * + * @param x - input array + * @param searchElement - search element + * @param fromIndex - starting index (inclusive) + * @param equalNaNs - boolean indicating whether NaNs should be considered equal + * @returns index + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * + * var idx = ns.indexOf( x, 2, 0, false ); + * // returns 1 + * + * @example + * var Int32Array = require( '@stdlib/array/int32' ); + * + * var x = new Int32Array( [ 1, 2, 3, 4 ] ); + * + * var idx = ns.indexOf( x, 2, 0, false ); + * // returns 1 + */ + indexOf: typeof indexOf; + /** * Returns the last element of an array-like object. * @@ -1626,6 +1658,37 @@ interface Namespace { */ last: typeof last; + /** + * Returns the index of the last element which equals a provided search element. + * + * ## Notes + * + * - The function scans an input array from the starting index to the beginning of the array (i.e., backward). + * - If unable to find an element which equals a provided search element, the function returns `-1`. + * - If `fromIndex` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `fromIndex = -1`. + * + * @param x - input array + * @param searchElement - search element + * @param fromIndex - starting index (inclusive) + * @param equalNaNs - boolean indicating whether NaNs should be considered equal + * @returns index + * + * @example + * var x = [ 1, 2, 3, 4 ]; + * + * var idx = ns.lastIndexOf( x, 2, 3, false ); + * // returns 1 + * + * @example + * var Int32Array = require( '@stdlib/array/int32' ); + * + * var x = new Int32Array( [ 1, 2, 3, 4 ] ); + * + * var idx = ns.lastIndexOf( x, 2, 3, false ); + * // returns 1 + */ + lastIndexOf: typeof lastIndexOf; + /** * Generates a linearly spaced numeric array. *