System.Array.BinarySearch Method

Searches a range of elements in a one-dimensional sorted array for a value, using the specified IComparer interface.

Syntax

[System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.WillNotCorruptState, System.Runtime.ConstrainedExecution.Cer.MayFail)]
public static int BinarySearch (Array array, int index, int length, object value, IComparer comparer)

Parameters

array
The sorted one-dimensional Array to search.
index
The starting index of the range to search.
length
The length of the range to search.
value
The object to search for.
comparer
The IComparer implementation to use when comparing elements.

Returns

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

Exceptions

TypeReason
ArgumentNullException array is null.
RankException array has more than one dimension.
ArgumentOutOfRangeException

index is less than array.GetLowerBound(0).

-or-

length is less than zero.

ArgumentException

index + length is greater than array.GetLowerBound(0) + array.Length.

-or-

array.UpperBound == int.MaxValue.

InvalidOperationException comparer is null, and both value and at least one element of array do not implement the IComparable interface.

Remarks

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 one greater than the upper bound 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 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 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 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.

Note:

If comparer is null 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.

null can always be compared with any other reference type; therefore, comparisons with null do not generate an exception when using IComparable.

Note:

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

This method is an O(log n) operation, where n is length.

Example

This example demonstrates the Array.BinarySearch(Array, object) method.

C# Example

using System;
class BinarySearchExample {
  public static void Main() {    
    int[] intAry = { 0, 2, 4, 6, 8 };
    Console.WriteLine( "The indices and elements of the array are: ");
    for ( int i = 0; i < intAry.Length; i++ )
      Console.Write("[{0}]: {1, -5}", i, intAry[i]);
    Console.WriteLine();
    SearchFor( intAry, 3 );
    SearchFor( intAry, 6 );
    SearchFor( intAry, 9 );
  }
  public static void SearchFor( Array ar, Object value ) {
    int i = Array.BinarySearch( ar, 0, ar.Length, value, null );
    Console.WriteLine();
    if ( i > 0 ) {
      Console.Write( "The object searched for, {0}, was found ", value );
      Console.WriteLine( "at index {1}.", value, i );
    }
    else if ( ~i == ar.Length ) {
      Console.Write( "The object searched for, {0}, was ", value );
      Console.Write( "not found,\nand no object in the array had " );
      Console.WriteLine( "greater value. " );
    }
    else {
      Console.Write( "The object searched for, {0}, was ", value );
      Console.Write( "not found.\nThe next larger object is at " );
      Console.WriteLine( "index {0}.", ~i );
    }
  }
}
   

The output is

The indices and elements of the array are:
[0]:0 [1]:2 [2]:4 [3]:6 [4]:8
The object searched for, 3, was not found.
The next larger object is at index 2.
The object searched for, 6, was found at index 3.
The object searched for, 9, was not found,
and no object in the array had greater value.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0