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)
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 sorted one-dimensional, zero-based Array to search.
The starting index of the range to search.
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; otherwise, a negative number. If value is not found and value is less than one or more elements in array, the negative number returned 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 all elements in array, the negative number returned is the bitwise complement of (the index of the last element plus 1). If this method is called with a non-sorted array, the return value can be incorrect and a negative number could be returned, even if value is present in array.
The type of the elements of the array.
array is null.
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 null, and value is of a type that is not compatible with the elements of array.
comparer is null, 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 null, 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 null, 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.
null can always be compared with any other reference type; therefore, comparisons with null 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 null. That is, the IComparable(Of T) implementation determines how a given element compares to null.
This method is an O(log n) operation, where n is length.
Available since 8
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 8.1