Click or drag to resize

GenericExtensions.BinarySearch Method

Overload List
  NameDescription
Public methodStatic memberCode exampleBinarySearch<T>(IList<T>, Func<T, Int32>)
Searches the entire sorted IList<T> for an element using the provided comparer and returns the zero-based index of the element.

This differs from the "ordinary" binary search in allowing a comparer delegate that defines whether an item is found (returning 0), whether the item in the list is before (<0) or after (>0) that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class.

Examples
If having a list of doubles, to find 4.5 in the list, use:
int index = list.BinarySearch(d => d.CompareTo(4.5))
Public methodStatic memberBinarySearch<T>(IList<T>, T)
Searches the entire sorted IList<T> for an element and returns the zero-based index of the element.

If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e.

list[interval-1] < key < list[interval]

Public methodStatic memberBinarySearch<T, TKey>(IList<T>, Func<T, TKey>, TKey)
Searches the entire sorted IList<T> for an element and returns the zero-based index of the element.

If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e.

list[interval-1] < key < list[interval]

This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class.

Public methodStatic memberBinarySearch<T>(IList<T>, T, IComparer<T>)
Searches the entire sorted IList<T> for an element using the provided comparer and returns the zero-based index of the element.

If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e.

list[interval-1] < key < list[interval]

Public methodStatic memberBinarySearch<T, TKey>(IList<T>, Func<T, TKey>, TKey, IComparer<TKey>)
Searches the entire sorted IList<T> for an element using the provided comparer and returns the zero-based index of the element.

If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e.

list[interval-1] < key < list[interval]

This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class.

Top
See Also