Function binarySearch

binarySearch(arr: any[], x: any, lo?: number, hi?: any, comp?: ((x: any, y: any) => number)): number
Returns the index of x in a sorted array if found, in O(log n) using binary search. If the element is not found, returns a negative integer.

Returns
The index if the element is found or a negative integer.
Parameters
- arr: any[]
  
  The array to sort
- x: any
  
  The element to find
- lo: number = 0
  
  The starting index
- Optional hi: any
  
  The end index to search within
- comp: ((x: any, y: any) => number) = compare
  
  The compare function to check for x
  - - (x: any, y: any): number
    - Checks whether x is a comparable type and returns the result of x.compare(y). Otherwise the return value of the compare function is equivalent to obj === other ? 0 : obj < other ? -1 : 1
      
      Returns
      The comparison result
      
      See
      
      Array.sort()
      
      eq
      
      lt
      
      Parameters
      
      x: any
      
      An initial value
      
      y: any
      
      Other value to compare
      
      Returns number
Returns number
- Defined in src/collections/index.ts:1078

Generated using TypeDoc