From 0342dd30b684ee99e050a08602ab2ecfe1feb539 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 30 Sep 2026 02:29:18 +0000 Subject: [PATCH] feat: update `blas/ext/base` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../blas/ext/base/docs/types/index.d.ts | 193 +++++++++++------- 1 file changed, 115 insertions(+), 78 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts index 840f9ffe0bb3..4a73b3326ecb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts @@ -226,6 +226,7 @@ import gindexOfFalsy = require( '@stdlib/blas/ext/base/gindex-of-falsy' ); import gindexOfFalsyRow = require( '@stdlib/blas/ext/base/gindex-of-falsy-row' ); import gindexOfGreaterThan = require( '@stdlib/blas/ext/base/gindex-of-greater-than' ); import gindexOfGreaterThanEqual = require( '@stdlib/blas/ext/base/gindex-of-greater-than-equal' ); +import gindexOfGreaterThanSorted = require( '@stdlib/blas/ext/base/gindex-of-greater-than-sorted' ); import gindexOfLessThan = require( '@stdlib/blas/ext/base/gindex-of-less-than' ); import gindexOfLessThanEqual = require( '@stdlib/blas/ext/base/gindex-of-less-than-equal' ); import gindexOfNotEqual = require( '@stdlib/blas/ext/base/gindex-of-not-equal' ); @@ -793,7 +794,7 @@ interface Namespace { * ## Notes * * - A complex number is falsy when both its real and imaginary components are falsy. - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -831,7 +832,7 @@ interface Namespace { * @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 LDA - stride length for 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 @@ -868,7 +869,7 @@ interface Namespace { * ## Notes * * - A complex number is truthy when at least one of its real or imaginary components is truthy. - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -2664,6 +2665,10 @@ interface Namespace { /** * Returns the index of the first element in a double-precision floating-point strided array equal to a corresponding element in another double-precision floating-point strided array. * + * ## Notes + * + * - If the function is unable to find an element in `x` which is equal to a corresponding element in `y`, the function returns `-1`. + * * @param N - number of indexed elements * @param x - first input array * @param strideX - stride length for `x` @@ -2677,7 +2682,7 @@ interface Namespace { * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float64Array( [ 0.0, 0.0, 3.0, 0.0 ] ); * - * var idx = ns.dfirstIndexEqual( 4, x, 1, y, 1 ); + * var idx = ns.dfirstIndexEqual( x.length, x, 1, y, 1 ); * // returns 2 * * @example @@ -2686,7 +2691,7 @@ interface Namespace { * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float64Array( [ 0.0, 0.0, 3.0, 0.0 ] ); * - * var idx = ns.dfirstIndexEqual.ndarray( 4, x, 1, 0, y, 1, 0 ); + * var idx = ns.dfirstIndexEqual.ndarray( x.length, x, 1, 0, y, 1, 0 ); * // returns 2 */ dfirstIndexEqual: typeof dfirstIndexEqual; @@ -2711,7 +2716,7 @@ interface Namespace { * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float64Array( [ 2.0, 2.0, 2.0, 2.0 ] ); * - * var idx = ns.dfirstIndexGreaterThan( 4, x, 1, y, 1 ); + * var idx = ns.dfirstIndexGreaterThan( x.length, x, 1, y, 1 ); * // returns 2 * * @example @@ -2720,7 +2725,7 @@ interface Namespace { * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float64Array( [ 2.0, 2.0, 2.0, 2.0 ] ); * - * var idx = ns.dfirstIndexGreaterThan.ndarray( 4, x, 1, 0, y, 1, 0 ); + * var idx = ns.dfirstIndexGreaterThan.ndarray( x.length, x, 1, 0, y, 1, 0 ); * // returns 2 */ dfirstIndexGreaterThan: typeof dfirstIndexGreaterThan; @@ -2802,7 +2807,7 @@ interface Namespace { * @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 LDA - stride length for 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 column match candidates @@ -2813,7 +2818,7 @@ interface Namespace { * var Float64Array = require( '@stdlib/array/float64' ); * var Uint8Array = require( '@stdlib/array/uint8' ); * - * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); + * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ] * var x = new Float64Array( [ 2.0, 4.0, 0.0 ] ); * var workspace = new Uint8Array( 2 ); * @@ -2824,7 +2829,7 @@ interface Namespace { * var Float64Array = require( '@stdlib/array/float64' ); * var Uint8Array = require( '@stdlib/array/uint8' ); * - * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); + * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ] * var x = new Float64Array( [ 2.0, 4.0, 0.0 ] ); * var workspace = new Uint8Array( 2 ); * @@ -2838,7 +2843,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -2849,18 +2854,18 @@ interface Namespace { * @example * var Float64Array = require( '@stdlib/array/float64' ); * - * var x = new Float64Array( [ 1.0, 0.0, 3.0, 2.0 ] ); + * var x = new Float64Array( [ 1.0, 2.0, 0.0, 3.0 ] ); * * var idx = ns.dindexOfFalsy( x.length, x, 1 ); - * // returns 1 + * // returns 2 * * @example * var Float64Array = require( '@stdlib/array/float64' ); * - * var x = new Float64Array( [ 1.0, 0.0, 3.0, 2.0 ] ); + * var x = new Float64Array( [ 1.0, 2.0, 0.0, 3.0 ] ); * * var idx = ns.dindexOfFalsy.ndarray( x.length, x, 1, 0 ); - * // returns 1 + * // returns 2 */ dindexOfFalsy: typeof dindexOfFalsy; @@ -2869,7 +2874,7 @@ interface Namespace { * * ## Notes * - * - If all elements are equal to the search element, the function returns `-1`. + * - If the function is unable to find an element which is not equal to the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -2907,7 +2912,7 @@ interface Namespace { * @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 LDA - stride length for 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 @@ -2918,7 +2923,7 @@ interface Namespace { * var Float64Array = require( '@stdlib/array/float64' ); * var Uint8Array = require( '@stdlib/array/uint8' ); * - * var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); + * var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); // => [ [ 1.0, 3.0 ], [ 2.0, 4.0 ], [ 0.0, 0.0 ] ] * var x = new Float64Array( [ 2.0, 4.0 ] ); * var workspace = new Uint8Array( 3 ); * @@ -2929,7 +2934,7 @@ interface Namespace { * var Float64Array = require( '@stdlib/array/float64' ); * var Uint8Array = require( '@stdlib/array/uint8' ); * - * var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); + * var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); // => [ [ 1.0, 3.0 ], [ 2.0, 4.0 ], [ 0.0, 0.0 ] ] * var x = new Float64Array( [ 2.0, 4.0 ] ); * var workspace = new Uint8Array( 3 ); * @@ -2943,7 +2948,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -2974,7 +2979,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -2989,7 +2994,7 @@ interface Namespace { * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float64Array( [ 0.0, 0.0, 3.0, 0.0 ] ); * - * var idx = ns.dlastIndexEqual( 4, x, 1, y, 1 ); + * var idx = ns.dlastIndexEqual( x.length, x, 1, y, 1 ); * // returns 2 * * @example @@ -2998,7 +3003,7 @@ interface Namespace { * var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float64Array( [ 0.0, 0.0, 3.0, 0.0 ] ); * - * var idx = ns.dlastIndexEqual.ndarray( 4, x, 1, 0, y, 1, 0 ); + * var idx = ns.dlastIndexEqual.ndarray( x.length, x, 1, 0, y, 1, 0 ); * // returns 2 */ dlastIndexEqual: typeof dlastIndexEqual; @@ -3039,7 +3044,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -3050,18 +3055,18 @@ interface Namespace { * @example * var Float64Array = require( '@stdlib/array/float64' ); * - * var x = new Float64Array( [ 1.0, 0.0, 2.0, 0.0 ] ); + * var x = new Float64Array( [ 1.0, 2.0, 0.0, 3.0 ] ); * * var idx = ns.dlastIndexOfFalsy( x.length, x, 1 ); - * // returns 3 + * // returns 2 * * @example * var Float64Array = require( '@stdlib/array/float64' ); * - * var x = new Float64Array( [ 1.0, 0.0, 2.0, 0.0 ] ); + * var x = new Float64Array( [ 1.0, 2.0, 0.0, 3.0 ] ); * * var idx = ns.dlastIndexOfFalsy.ndarray( x.length, x, 1, 0 ); - * // returns 3 + * // returns 2 */ dlastIndexOfFalsy: typeof dlastIndexOfFalsy; @@ -3113,7 +3118,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -6288,7 +6293,7 @@ interface Namespace { * - `sidx`: strided index (offset + aidx*stride) * - `array`: input array * - * - If no element passes a test implemented by a predicate function, the function returns `-1`. + * - If the function is unable to find an element which passes a test implemented by a predicate function, the function returns `-1`. * * @param N - number of indexed elements * @param x - input array @@ -6331,7 +6336,7 @@ interface Namespace { * - `sidx`: strided index (offset + aidx*stride) * - `array`: input array * - * - If no element passes a test implemented by a predicate function, the function returns `-1`. + * - If the function is unable to find an element which passes a test implemented by a predicate function, the function returns `-1`. * * @param N - number of indexed elements * @param x - input array @@ -6367,7 +6372,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is almost equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param maxULP - maximum allowed ULP difference @@ -6398,7 +6403,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is almost the same value as a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param maxULP - maximum allowed ULP difference @@ -6429,7 +6434,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -6575,11 +6580,11 @@ interface Namespace { gfirstIndexLessThanEqual: typeof gfirstIndexLessThanEqual; /** - * Returns the index of the first element in a strided array which is not equal to the corresponding element in another strided array. + * Returns the index of the first element in a strided array which is not equal to a corresponding element in another strided array. * * ## Notes * - * - If unable to find an element in `x` which is not equal to the corresponding element in `y`, the function returns `-1`. + * - If the function is unable to find an element in `x` which is not equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -6632,7 +6637,7 @@ interface Namespace { gindexOf: typeof gindexOf; /** - * Returns the index of the first element in a strided array which is almost the same value as a provided search element. + * Returns the first index of an element in a strided array which is almost the same value as a specified search element. * * ## Notes * @@ -6670,7 +6675,7 @@ interface Namespace { * @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 LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) * @param x - search vector * @param strideX - stride length for `x` * @returns column index @@ -6696,7 +6701,8 @@ interface Namespace { * * ## Notes * - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. + * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements * @param x - input array @@ -6728,17 +6734,17 @@ interface Namespace { * @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 LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) * @returns row index * * @example - * var A = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0 ]; + * var A = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0 ]; // => [ [ 1.0, 1.0, 1.0, 1.0 ], [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ], [ 1.0, 1.0, 1.0, 1.0 ] ] * * var out = ns.gindexOfFalsyRow( 'row-major', 4, 4, A, 4 ); * // returns 1 * * @example - * var A = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0 ]; + * var A = [ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0 ]; // => [ [ 1.0, 1.0, 1.0, 1.0 ], [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ], [ 1.0, 1.0, 1.0, 1.0 ] ] * * var out = ns.gindexOfFalsyRow.ndarray( 4, 4, A, 4, 1, 0 ); * // returns 1 @@ -6746,11 +6752,11 @@ interface Namespace { gindexOfFalsyRow: typeof gindexOfFalsyRow; /** - * Returns the index of the first element in a strided array which is greater than a specified search element. + * Returns the first index of an element in a strided array which is greater than a specified search element. * * ## Notes * - * - If the function is unable to find an element which is greater than a search element, the function returns `-1`. + * - If the function is unable to find an element which is greater than the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -6773,11 +6779,11 @@ interface Namespace { gindexOfGreaterThan: typeof gindexOfGreaterThan; /** - * Returns the index of the first element in a strided array which is greater than or equal to a specified search element. + * Returns the first index of an element in a strided array which is greater than or equal to a specified search element. * * ## Notes * - * - If the function is unable to find an element which is greater than or equal to a search element, the function returns `-1`. + * - If the function is unable to find an element which is greater than or equal to the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -6799,12 +6805,40 @@ interface Namespace { */ gindexOfGreaterThanEqual: typeof gindexOfGreaterThanEqual; + /** + * Returns the index of the first element in a sorted strided array which is greater than a specified search element. + * + * ## Notes + * + * - The input strided array must be sorted in ascending order. + * - If the function is unable to find an element which is greater than a search element, the function returns `-1`. + * + * @param N - number of indexed elements + * @param searchElement - search element + * @param x - sorted input array + * @param strideX - stride length + * @returns index + * + * @example + * var x = [ 1.0, 2.0, 2.0, 3.0 ]; + * + * var idx = ns.gindexOfGreaterThanSorted( x.length, 2.0, x, 1 ); + * // returns 3 + * + * @example + * var x = [ 1.0, 2.0, 2.0, 3.0 ]; + * + * var idx = ns.gindexOfGreaterThanSorted.ndarray( x.length, 2.0, x, 1, 0 ); + * // returns 3 + */ + gindexOfGreaterThanSorted: typeof gindexOfGreaterThanSorted; + /** * Returns the first index of an element in a strided array which is less than a specified search element. * * ## Notes * - * - If unable to find an element which is less than the search element, the function returns `-1`. + * - If the function is unable to find an element which is less than the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -6831,7 +6865,7 @@ interface Namespace { * * ## Notes * - * - If unable to find an element which is less than or equal to the search element, the function returns `-1`. + * - If the function is unable to find an element which is less than or equal to the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -6858,7 +6892,7 @@ interface Namespace { * * ## Notes * - * - If all elements are equal to the search element, the function returns `-1`. + * - If the function is unable to find an element which is not equal to the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -6891,7 +6925,7 @@ interface Namespace { * @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 LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) * @param x - search vector * @param strideX - stride length for `x` * @returns row index @@ -6913,7 +6947,7 @@ interface Namespace { gindexOfRow: typeof gindexOfRow; /** - * Returns the index of the first element in a strided array which has the same value as a provided search element. + * Returns the first index of an element in a strided array which has the same value as a specified search element. * * ## Notes * @@ -6944,7 +6978,8 @@ interface Namespace { * * ## Notes * - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. + * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements * @param x - input array @@ -6976,17 +7011,17 @@ interface Namespace { * @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 LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) * @returns row index * * @example - * var A = [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]; + * var A = [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]; // => [ [ 0.0, 0.0, 0.0, 0.0 ], [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0, 1.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] * * var out = ns.gindexOfTruthyRow( 'row-major', 4, 4, A, 4 ); * // returns 1 * * @example - * var A = [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]; + * var A = [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 ]; // => [ [ 0.0, 0.0, 0.0, 0.0 ], [ 1.0, 0.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0, 1.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] * * var out = ns.gindexOfTruthyRow.ndarray( 4, 4, A, 4, 1, 0 ); * // returns 1 @@ -7049,7 +7084,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is almost the same value as a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param maxULP - maximum allowed ULP difference @@ -7080,7 +7115,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -7226,11 +7261,11 @@ interface Namespace { glastIndexLessThanEqual: typeof glastIndexLessThanEqual; /** - * Returns the index of the last element in a strided array which is not equal to the corresponding element in another strided array. + * Returns the index of the last element in a strided array which is not equal to a corresponding element in another strided array. * * ## Notes * - * - If unable to find an element in `x` which is not equal to the corresponding element in `y`, the function returns `-1`. + * - If the function is unable to find an element in `x` which is not equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -7287,7 +7322,8 @@ interface Namespace { * * ## Notes * - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. + * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements * @param x - input array @@ -7350,7 +7386,8 @@ interface Namespace { * * ## Notes * - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. + * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements * @param x - input array @@ -10001,7 +10038,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find a match, the function returns `-1`. + * - If the function is unable to find an element in `x` which is equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -10143,7 +10180,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -10174,7 +10211,7 @@ interface Namespace { * * ## Notes * - * - If all elements are equal to the search element, the function returns `-1`. + * - If the function is unable to find an element which is not equal to the search element, the function returns `-1`. * * @param N - number of indexed elements * @param searchElement - search element @@ -10212,7 +10249,7 @@ interface Namespace { * @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 LDA - stride length for 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 @@ -10223,7 +10260,7 @@ interface Namespace { * var Float32Array = require( '@stdlib/array/float32' ); * var Uint8Array = require( '@stdlib/array/uint8' ); * - * var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); + * var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); // => [ [ 1.0, 3.0 ], [ 2.0, 4.0 ], [ 0.0, 0.0 ] ] * var x = new Float32Array( [ 2.0, 4.0 ] ); * var workspace = new Uint8Array( 3 ); * @@ -10234,7 +10271,7 @@ interface Namespace { * var Float32Array = require( '@stdlib/array/float32' ); * var Uint8Array = require( '@stdlib/array/uint8' ); * - * var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); + * var A = new Float32Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); // => [ [ 1.0, 3.0 ], [ 2.0, 4.0 ], [ 0.0, 0.0 ] ] * var x = new Float32Array( [ 2.0, 4.0 ] ); * var workspace = new Uint8Array( 3 ); * @@ -10248,7 +10285,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -10279,7 +10316,7 @@ interface Namespace { * * ## Notes * - * - If the function is unable to find matching elements, the function returns `-1`. + * - If the function is unable to find an element in `x` which is equal to a corresponding element in `y`, the function returns `-1`. * * @param N - number of indexed elements * @param x - first input array @@ -10294,7 +10331,7 @@ interface Namespace { * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float32Array( [ 0.0, 0.0, 3.0, 0.0 ] ); * - * var idx = ns.slastIndexEqual( 4, x, 1, y, 1 ); + * var idx = ns.slastIndexEqual( x.length, x, 1, y, 1 ); * // returns 2 * * @example @@ -10303,7 +10340,7 @@ interface Namespace { * var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); * var y = new Float32Array( [ 0.0, 0.0, 3.0, 0.0 ] ); * - * var idx = ns.slastIndexEqual.ndarray( 4, x, 1, 0, y, 1, 0 ); + * var idx = ns.slastIndexEqual.ndarray( x.length, x, 1, 0, y, 1, 0 ); * // returns 2 */ slastIndexEqual: typeof slastIndexEqual; @@ -10344,7 +10381,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -10418,7 +10455,7 @@ interface Namespace { * * ## Notes * - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -12350,7 +12387,7 @@ interface Namespace { * ## Notes * * - A complex number is falsy when both its real and imaginary components are falsy. - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -12425,7 +12462,7 @@ interface Namespace { * ## Notes * * - A complex number is truthy when at least one of its real or imaginary components is truthy. - * - If unable to find a truthy element, the function returns `-1`. + * - If the function is unable to find a truthy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements @@ -12436,7 +12473,7 @@ interface Namespace { * @example * var Complex128Array = require( '@stdlib/array/complex128' ); * - * var x = new Complex128Array( [ 0.0, 0.0, 1.0, 2.0 ] ); + * var x = new Complex128Array( [ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ); * * var idx = ns.zindexOfTruthy( x.length, x, 1 ); * // returns 1 @@ -12444,7 +12481,7 @@ interface Namespace { * @example * var Complex128Array = require( '@stdlib/array/complex128' ); * - * var x = new Complex128Array( [ 0.0, 0.0, 1.0, 2.0 ] ); + * var x = new Complex128Array( [ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0 ] ); * * var idx = ns.zindexOfTruthy.ndarray( x.length, x, 1, 0 ); * // returns 1 @@ -12457,7 +12494,7 @@ interface Namespace { * ## Notes * * - A complex number is falsy when both its real and imaginary components are falsy. - * - If unable to find a falsy element, the function returns `-1`. + * - If the function is unable to find a falsy element, the function returns `-1`. * - The function explicitly treats `NaN` values as falsy. * * @param N - number of indexed elements