Array.BinarySearch Method (Array, Object, IComparer)

July 28, 2014

Searches an entire one-dimensional sorted Array for a value using the specified IComparer interface.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Shared Function BinarySearch ( _
	array As Array, _
	value As Object, _
	comparer As IComparer _
) As Integer

Parameters

array
Type: System.Array
The sorted one-dimensional Array to search.
value
Type: System.Object
The object to search for.
comparer
Type: System.Collections.IComparer
The IComparer implementation to use when comparing elements.
-or-
Nothing to use the IComparable implementation of each element.

Return Value

Type: 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).

ExceptionCondition
ArgumentNullException

array is Nothing.

RankException

array is multidimensional.

ArgumentException

comparer is Nothing, and value is of a type that is not compatible with the elements of array.

InvalidOperationException

comparer is Nothing, value does not implement the IComparable interface, and the search encounters an element that does not implement the IComparable interface.

If the Array does not contain the specified value, the method returns a negative integer. You can apply the bitwise complement operator (~) to the negative result (in Visual Basic, Xor the negative result with -1) to produce an index. If this index is greater than or 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.

If comparer is not Nothing, the elements of array are compared to the specified value using the specified IComparer 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 implementation provided by the element itself or by the specified value. The elements of array must already be sorted in increasing value according to the sort order defined by the IComparable implementation; otherwise, the result might be incorrect.

NoteNote:

If comparer is Nothing and value does not implement the IComparable interface, the elements of array are not tested for IComparable before the search begins. An exception is thrown if the search encounters an element that does not implement IComparable.

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 sorting, Nothing is considered to be less than any other object.

NoteNote:

   For every element tested, value is passed to the appropriate IComparable implementation, even if value is Nothing. That is, the IComparable implementation determines how a given element compares to Nothing.

This method is an O(log n) operation, where n is the Length of array.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft