Array.BinarySearch(Of T) Method (T(), T)

Searches an entire one-dimensional sorted Array for a specific element, using the IComparable(Of T) generic interface implemented by each element of the Array and by the specified object.

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

'Declaration
Public Shared Function BinarySearch(Of T) ( _
	array As T(), _
	value As T _
) As Integer

Type Parameters

T

The type of the elements of the array.

Parameters

array
Type: T()
The sorted one-dimensional, zero-based Array to search.
value
Type: T
The object to search for.

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.

InvalidOperationException

value does not implement the IComparable(Of T) generic interface, and the search encounters an element that does not implement the IComparable(Of T) generic 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.

Either value or every element of array must implement the IComparable(Of T) generic interface, which is used for comparisons. 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.

NoteNote:

If value does not implement the IComparable(Of T) generic interface, the elements of array are not tested for IComparable(Of T) before the search begins. An exception is thrown if the search encounters an element that does not implement IComparable(Of T).

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(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 the Length of array.

The following code example demonstrates the Sort(Of T)(T()) generic method overload and the BinarySearch(Of T)(T(), T) generic method overload. An array of strings is created, in no particular order.

The array is displayed, sorted, and displayed again. Arrays must be sorted in order to use the BinarySearch method.

NoteNote:

The calls to the Sort and BinarySearch generic methods do not look any different from calls to their nongeneric counterparts, because Visual Basic, C#, and C++ infer the type of the generic type parameter from the type of the first argument.

The BinarySearch(Of T)(T(), T) generic method overload is then used to search for two strings, one that is not in the array and one that is. The array and the return value of the BinarySearch method are passed to the ShowWhere generic method, which displays the index value if the string is found, and otherwise the elements the search string would fall between if it were in the array. The index is negative if the string is not n the array, so the ShowWhere method takes the bitwise complement (the ~ operator in C# and Visual C++, Xor -1 in Visual Basic) to obtain the index of the first element in the list that is larger than the search string.


Imports System.Collections.Generic

Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

      Dim dinosaurs() As String = { _
          "Pachycephalosaurus", _
          "Amargasaurus", _
          "Tyrannosaurus", _
          "Mamenchisaurus", _
          "Deinonychus", _
          "Edmontosaurus"}

      outputBlock.Text &= vbCrLf
      For Each dinosaur As String In dinosaurs
         outputBlock.Text &= dinosaur & vbCrLf
      Next

      outputBlock.Text &= vbLf & "Sort" & vbCrLf
      Array.Sort(dinosaurs)

      outputBlock.Text &= vbCrLf
      For Each dinosaur As String In dinosaurs
         outputBlock.Text &= dinosaur & vbCrLf
      Next

      outputBlock.Text &= vbLf & _
          "BinarySearch for 'Coelophysis':" & vbCrLf
      Dim index As Integer = _
          Array.BinarySearch(dinosaurs, "Coelophysis")
      ShowWhere(outputBlock, dinosaurs, index)

      outputBlock.Text &= vbLf & _
          "BinarySearch for 'Tyrannosaurus':" & vbCrLf
      index = Array.BinarySearch(dinosaurs, "Tyrannosaurus")
      ShowWhere(outputBlock, dinosaurs, index)

   End Sub

   Private Shared Sub ShowWhere(Of T) _
       (ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal array() As T, ByVal index As Integer)

      If index < 0 Then
         ' If the index is negative, it represents the bitwise
         ' complement of the next larger element in the array.
         '
         index = index Xor -1

         outputBlock.Text &= "Not found. Sorts between: "

         If index = 0 Then
            outputBlock.Text &= "beginning of array and "
         Else
            outputBlock.Text &= String.Format("{0} and ", array(index - 1))
         End If

         If index = array.Length Then
            outputBlock.Text &= "end of array." & vbCrLf
         Else
            outputBlock.Text &= String.Format("{0}.", array(index)) & vbCrLf
         End If
      Else
         outputBlock.Text &= String.Format("Found at index {0}.", index) & vbCrLf
      End If

   End Sub

End Class

' This code example produces the following output:
'
'Pachycephalosaurus
'Amargasaurus
'Tyrannosaurus
'Mamenchisaurus
'Deinonychus
'Edmontosaurus
'
'Sort
'
'Amargasaurus
'Deinonychus
'Edmontosaurus
'Mamenchisaurus
'Pachycephalosaurus
'Tyrannosaurus
'
'BinarySearch for 'Coelophysis':
'Not found. Sorts between: Amargasaurus and Deinonychus.
'
'BinarySearch for 'Tyrannosaurus':
'Found at index 5.


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show: