rc-js-util
Version:
A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.
25 lines • 1.34 kB
TypeScript
import { TGetComparisonValueAtIndex } from "./binary-find-insertion-index.js";
/**
* @public
* Performs a bisection search of an 'indexable' object, i.e. can be accessed by index, for example `Array`. Custom data structures are also supported.
* @param indexable - The thing to be searched. This must be sorted ascending.
* @param comparisonValueToSearchFor - The comparison value which is being searched for.
* @param getComparisonValueAtIndex - A function that provides the value for comparison at a given index.
* @param length - The number of elements in the structure `indexable` to search.
* @param start - The start index.
* @returns The index of the searched for item, else -1 if it cannot be found.
*
* @example
* ```typescript
* // searching for the number 3 with start index 1 & length 2
* const index = arrayBinaryIndexOf([1, 2, 3, 4], 3, (a, i) => a[i], 2, 1);
* // index is 2
* ```
*
* @remarks
* The `indexable` parameter must be sorted ascending. Where there are multiple equal values the lowest index will be returned.
*
* See {@link arrayBinaryIndexOf}.
*/
export declare function arrayBinaryIndexOf<T>(indexable: T, comparisonValueToSearchFor: number, getComparisonValueAtIndex: TGetComparisonValueAtIndex<T>, length: number, start?: number): number;
//# sourceMappingURL=array-binary-index-of.d.ts.map