Export (0) Print
Expand All

Array.BinarySearch Generic Method (T[], Int32, Int32, T, Generic IComparer)

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

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

public static int BinarySearch<T> (
	T[] array,
	int index,
	int length,
	T value,
	IComparer<T> comparer
)
J# supports the use of generic types and methods, but not the declaration of new ones.
JScript does not support generic types and methods.
Not applicable.

Type Parameters

T

The type of the elements of the array.

Parameters

array

The sorted one-dimensional, zero-based 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.

-or-

a null reference (Nothing in Visual Basic) to use the IComparable implementation of each element.

Return Value

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

Exception typeCondition

ArgumentNullException

array is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

index is less than the lower bound of array.

-or-

length is less than zero.

ArgumentException

index and length do not specify a valid range in array.

-or-

comparer is a null reference (Nothing in Visual Basic), and value is of a type that is not compatible with the elements of array.

InvalidOperationException

comparer is a null reference (Nothing in Visual Basic), value does not implement the IComparable generic interface, and the search encounters an element that does not implement the IComparable 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.

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 a null reference (Nothing in Visual Basic), the elements of array are compared to the specified value using the specified IComparer 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 a null reference (Nothing in Visual Basic), the comparison is done using the IComparable generic interface 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 a null reference (Nothing in Visual Basic) and value does not implement the IComparable generic 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.

a null reference (Nothing in Visual Basic) can always be compared with any other reference type; therefore, comparisons with a null reference (Nothing in Visual Basic) do not generate an exception when using IComparable. When sorting, a null reference (Nothing in Visual Basic) 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 a null reference (Nothing in Visual Basic). That is, the IComparable implementation determines how a given element compares to a null reference (Nothing in Visual Basic).

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft