Export (0) Print
Expand All

Array.Sort(T) Method (T[], IComparer(T))

Sorts the elements in an Array using the specified IComparer(T) generic interface.

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

static member Sort : 
        array:'T[] * 
        comparer:IComparer<'T> -> unit

Type Parameters

T

The type of the elements of the array.

Parameters

array
Type: T[]

The one-dimensional, zero-base Array to sort

comparer
Type: System.Collections.Generic.IComparer(T)

The IComparer(T) generic interface implementation to use when comparing elements, or a null reference (Nothing in Visual Basic) to use the IComparable(T) generic interface implementation of each element.

ExceptionCondition
ArgumentNullException

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

InvalidOperationException

comparer is a null reference (Nothing in Visual Basic), and one or more elements in array do not implement the IComparable(T) generic interface.

ArgumentException

The implementation of comparer caused an error during the sort. For example, comparer might not return 0 when comparing an item with itself.

If comparer is a null reference (Nothing in Visual Basic), each element of array must implement the IComparable(T) generic interface to be capable of comparisons with every other element in array.

If the sort is not successfully completed, the results are undefined.

This method uses the introspective sort (introsort) algorithm as follows:

  • If the partition size is fewer than 16 elements, it uses an insertion sort algorithm.

  • If the number of partitions exceeds 2 * LogN, where N is the range of the input array, it uses a Heapsort algorithm.

  • Otherwise, it uses a Quicksort algorithm.

This implementation performs an unstable sort; that is, if two elements are equal, their order might not be preserved. In contrast, a stable sort preserves the order of elements that are equal.

For arrays that are sorted by using the Heapsort and Quicksort algorithms, in the worst case, this method is an O(n log n) operation, where n is the Length of array.

Notes to Callers

The .NET Framework 4 and earlier versions used only the Quicksort algorithm. Quicksort identifies invalid comparers in some situations in which the sorting operation throws an IndexOutOfRangeException exception, and throws an ArgumentException exception to the caller. Starting with the .NET Framework 4.5, it is possible that sorting operations that previously threw ArgumentException will not throw an exception, because the insertion sort and heapsort algorithms do not detect an invalid comparer. For the most part, this applies to arrays with fewer than 16 elements.

The following code example demonstrates the Sort(T)(T[], IComparer(T)) generic method overload and the BinarySearch(T)(T[], T, IComparer(T)) generic method overload.

The code example defines an alternative comparer for strings, named ReverseCompare, which implements the IComparer<string> (IComparer(Of String) in Visual Basic, IComparer<String^> in Visual C++) generic interface. The comparer calls the CompareTo(String) method, reversing the order of the comparands so that the strings sort high-to-low instead of low-to-high.

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(T)(T[], IComparer(T)) and BinarySearch(T)(T[], T, IComparer(T)) 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. If you use the Ildasm.exe (IL Disassembler) to examine the Microsoft intermediate language (MSIL), you can see that the generic methods are being called.

The BinarySearch(T)(T[], T, IComparer(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(T)(T[], T, IComparer(T)) 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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft