Array.BinarySearch(Of T) Method (T(), Int32, Int32, T, IComparer(Of T))
Searches a range of elements in a one-dimensional sorted array for a value, using the specified IComparer(Of T) generic interface.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Shared Function BinarySearch(Of T) ( _ array As T(), _ index As Integer, _ length As Integer, _ value As T, _ comparer As IComparer(Of T) _ ) As Integer
The type of the elements of the array.
- Type: ()
The sorted one-dimensional, zero-based Array to search.
- Type: System.Int32
The starting index of the range to search.
- Type: System.Int32
The length of the range to search.
The object to search for.
Return ValueType: System.Int32
The index of the specified value in the specified array, if value is found. If value is not found and value is less than one or more elements in array, a negative number which is the bitwise complement of the index of the first element that is larger than value. If value is not found and value is greater than any of the elements in array, a negative number which is the bitwise complement of (the index of the last element plus 1).
array is Nothing.
index is less than the lower bound of array.
length is less than zero.
index and length do not specify a valid range in array.
comparer is Nothing, and value is of a type that is not compatible with the elements of array.
comparer is Nothing, and T does not implement the IComparable(Of T) generic interface.
This method does not support searching arrays that contain negative indexes. array must be sorted before calling this method.
If the array does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operator (~ in C#, Not in Visual Basic) to the negative result to produce an index. If this index is equal to the size of the array, there are no elements larger than value in the array. Otherwise, it is the index of the first element that is larger than value.
The comparer customizes how the elements are compared. For example, you can use a System.Collections.CaseInsensitiveComparer as the comparer to perform case-insensitive string searches.
If comparer is not Nothing, the elements of array are compared to the specified value using the specified IComparer(Of T) generic interface implementation. The elements of array must already be sorted in increasing value according to the sort order defined by comparer; otherwise, the result might be incorrect.
If comparer is Nothing, the comparison is done using the IComparable(Of T) generic interface implementation provided for type T. The elements of array must already be sorted in increasing value according to the sort order defined by the IComparable(Of T) implementation; otherwise, the result might be incorrect.
Duplicate elements are allowed. If the Array contains more than one element equal to value, the method returns the index of only one of the occurrences, and not necessarily the first one.
Nothing can always be compared with any other reference type; therefore, comparisons with Nothing do not generate an exception when using IComparable(Of T).
For every element tested, value is passed to the appropriate IComparable(Of T) implementation, even if value is Nothing. That is, the IComparable(Of T) implementation determines how a given element compares to Nothing.
This method is an O(log n) operation, where n is length.