Skip to main content
.NET Framework Class Library
ArraySort Method (Array)

Sorts the elements in an entire one-dimensional Array using the IComparable implementation of each element of the Array.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
Public Shared Sub Sort ( _
	array As [%$TOPIC/6tf1f0bc_en-us_VS_110_4_0_0_0_0%] _
)
public static void Sort(
	[%$TOPIC/6tf1f0bc_en-us_VS_110_4_0_1_0_0%] array
)
public:
static void Sort(
	[%$TOPIC/6tf1f0bc_en-us_VS_110_4_0_2_0_0%]^ array
)
static member Sort : 
        array:[%$TOPIC/6tf1f0bc_en-us_VS_110_4_0_3_0_0%] -> unit

Parameters

array
Type: SystemArray

The one-dimensional Array to sort.

Exceptions
ExceptionCondition
ArgumentNullException

array is .

RankException

array is multidimensional.

InvalidOperationException

One or more elements in array do not implement the IComparable interface.

Remarks

Each element of array must implement the IComparable 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.

Examples

The following code example shows how to sort the values in an Array using the default comparer and a custom comparer that reverses the sort order. Note that the result might vary depending on the current CultureInfo.

Imports System.Collections

Public Class ReverseComparer : Implements IComparer
   ' Call CaseInsensitiveComparer.Compare with the parameters reversed. 
   Function Compare(x As Object, y As Object) As Integer _
            Implements IComparer.Compare
      Return New CaseInsensitiveComparer().Compare(y, x)
   End Function  
End Class 

Public Module Example
   Public Sub Main()
      ' Create and initialize a new array. 
      Dim words() As String =  { "The", "QUICK", "BROWN", "FOX", "jumps", 
                                 "over", "the", "lazy", "dog" }
      ' Instantiate a new custom comparer. 
      Dim revComparer As New ReverseComparer()

      ' Display the values of the array.
      Console.WriteLine( "The original order of elements in the array:" )
      DisplayValues(words)

      ' Sort a section of the array using the default comparer.
      Array.Sort(words, 1, 3)
      Console.WriteLine( "After sorting elements 1-3 by using the default comparer:")
      DisplayValues(words)

      ' Sort a section of the array using the reverse case-insensitive comparer.
      Array.Sort(words, 1, 3, revComparer)
      Console.WriteLine( "After sorting elements 1-3 by using the reverse case-insensitive comparer:")
      DisplayValues(words)

      ' Sort the entire array using the default comparer.
      Array.Sort(words)
      Console.WriteLine( "After sorting the entire array by using the default comparer:")
      DisplayValues(words)

      ' Sort the entire array by using the reverse case-insensitive comparer.
      Array.Sort(words, revComparer)
      Console.WriteLine( "After sorting the entire array using the reverse case-insensitive comparer:")
      DisplayValues(words)
   End Sub  

   Public Sub DisplayValues(arr() As String)
      For i As Integer = arr.GetLowerBound(0) To arr.GetUpperBound(0)
         Console.WriteLine("   [{0}] : {1}", i, arr(i))
      Next 
      Console.WriteLine()
   End Sub  
End Module  
' The example displays the following output: 
'    The original order of elements in the array: 
'       [0] : The 
'       [1] : QUICK 
'       [2] : BROWN 
'       [3] : FOX 
'       [4] : jumps 
'       [5] : over 
'       [6] : the 
'       [7] : lazy 
'       [8] : dog 
'     
'    After sorting elements 1-3 by using the default comparer: 
'       [0] : The 
'       [1] : BROWN 
'       [2] : FOX 
'       [3] : QUICK 
'       [4] : jumps 
'       [5] : over 
'       [6] : the 
'       [7] : lazy 
'       [8] : dog 
'     
'    After sorting elements 1-3 by using the reverse case-insensitive comparer: 
'       [0] : The 
'       [1] : QUICK 
'       [2] : FOX 
'       [3] : BROWN 
'       [4] : jumps 
'       [5] : over 
'       [6] : the 
'       [7] : lazy 
'       [8] : dog 
'     
'    After sorting the entire array by using the default comparer: 
'       [0] : BROWN 
'       [1] : dog 
'       [2] : FOX 
'       [3] : jumps 
'       [4] : lazy 
'       [5] : over 
'       [6] : QUICK 
'       [7] : the 
'       [8] : The 
'     
'    After sorting the entire array using the reverse case-insensitive comparer: 
'       [0] : the 
'       [1] : The 
'       [2] : QUICK 
'       [3] : over 
'       [4] : lazy 
'       [5] : jumps 
'       [6] : FOX 
'       [7] : dog 
'       [8] : BROWN
using System;
using System.Collections;

public class ReverseComparer : IComparer  
{
   // Call CaseInsensitiveComparer.Compare with the parameters reversed. 
   public int Compare(Object x, Object y)  
   {
       return (new CaseInsensitiveComparer()).Compare(y, x );
   }
}

public class Example 
{
   public static void Main()  
   {
      // Create and initialize a new array. 
      String[] words = { "The", "QUICK", "BROWN", "FOX", "jumps", 
                         "over", "the", "lazy", "dog" };
      // Instantiate the reverse comparer.
      IComparer revComparer = new ReverseComparer();

      // Display the values of the array.
      Console.WriteLine( "The original order of elements in the array:" );
      DisplayValues(words);

      // Sort a section of the array using the default comparer.
      Array.Sort(words, 1, 3);
      Console.WriteLine( "After sorting elements 1-3 by using the default comparer:");
      DisplayValues(words);

      // Sort a section of the array using the reverse case-insensitive comparer.
      Array.Sort(words, 1, 3, revComparer);
      Console.WriteLine( "After sorting elements 1-3 by using the reverse case-insensitive comparer:");
      DisplayValues(words);

      // Sort the entire array using the default comparer.
      Array.Sort(words);
      Console.WriteLine( "After sorting the entire array by using the default comparer:");
      DisplayValues(words);

      // Sort the entire array by using the reverse case-insensitive comparer.
      Array.Sort(words, revComparer);
      Console.WriteLine( "After sorting the entire array using the reverse case-insensitive comparer:");
      DisplayValues(words);
   }

   public static void DisplayValues(String[] arr)  
   {
      for ( int i = arr.GetLowerBound(0); i <= arr.GetUpperBound(0);
            i++ )  {
         Console.WriteLine( "   [{0}] : {1}", i, arr[i] );
      }
      Console.WriteLine();
   }
}
// The example displays the following output: 
//    The original order of elements in the array: 
//       [0] : The 
//       [1] : QUICK 
//       [2] : BROWN 
//       [3] : FOX 
//       [4] : jumps 
//       [5] : over 
//       [6] : the 
//       [7] : lazy 
//       [8] : dog 
//     
//    After sorting elements 1-3 by using the default comparer: 
//       [0] : The 
//       [1] : BROWN 
//       [2] : FOX 
//       [3] : QUICK 
//       [4] : jumps 
//       [5] : over 
//       [6] : the 
//       [7] : lazy 
//       [8] : dog 
//     
//    After sorting elements 1-3 by using the reverse case-insensitive comparer: 
//       [0] : The 
//       [1] : QUICK 
//       [2] : FOX 
//       [3] : BROWN 
//       [4] : jumps 
//       [5] : over 
//       [6] : the 
//       [7] : lazy 
//       [8] : dog 
//     
//    After sorting the entire array by using the default comparer: 
//       [0] : BROWN 
//       [1] : dog 
//       [2] : FOX 
//       [3] : jumps 
//       [4] : lazy 
//       [5] : over 
//       [6] : QUICK 
//       [7] : the 
//       [8] : The 
//     
//    After sorting the entire array using the reverse case-insensitive comparer: 
//       [0] : the 
//       [1] : The 
//       [2] : QUICK 
//       [3] : over 
//       [4] : lazy 
//       [5] : jumps 
//       [6] : FOX 
//       [7] : dog 
//       [8] : BROWN    
using namespace System;
using namespace System::Collections;

public ref class ReverseComparer : IComparer
{
public:
   // Call CaseInsensitiveComparer::Compare with the parameters reversed. 
   virtual int Compare(Object^ x, Object^ y) = IComparer::Compare
   {
      return ((gcnew CaseInsensitiveComparer)->Compare(y, x));
   }
};

void DisplayValues(array<String^>^ arr)
{
   for (int i = arr->GetLowerBound(0); i <= arr->GetUpperBound(0); i++)
      Console::WriteLine( "   [{0}] : {1}", i, arr[ i ] );

   Console::WriteLine();
}

int main()
{
   // Create and initialize a new array. and a new custom comparer. 
   array<String^>^ words = { "The","QUICK","BROWN","FOX","jumps",
                             "over","the","lazy","dog" };
   // Instantiate the reverse comparer.
   IComparer^ revComparer = gcnew ReverseComparer();

   // Display the values of the Array.
   Console::WriteLine( "The original order of elements in the array:" );
   DisplayValues(words);

   // Sort a section of the array using the default comparer.
   Array::Sort(words, 1, 3);
   Console::WriteLine( "After sorting elements 1-3 by using the default comparer:");
   DisplayValues(words);

   // Sort a section of the array using the reverse case-insensitive comparer.
   Array::Sort(words, 1, 3, revComparer);
   Console::WriteLine( "After sorting elements 1-3 by using the reverse case-insensitive comparer:");
   DisplayValues(words);

   // Sort the entire array using the default comparer.
   Array::Sort(words);
   Console::WriteLine( "After sorting the entire array by using the default comparer:");
   DisplayValues(words);

   // Sort the entire array by using the reverse case-insensitive comparer.
   Array::Sort(words, revComparer);
   Console::WriteLine( "After sorting the entire array using the reverse case-insensitive comparer:");
   DisplayValues(words);
}

/* 
This code produces the following output.

The Array initially contains the following values:
   [0] : The
   [1] : QUICK
   [2] : BROWN
   [3] : FOX
   [4] : jumps
   [5] : over
   [6] : the
   [7] : lazy
   [8] : dog

After sorting a section of the Array using the default comparer:
   [0] : The
   [1] : BROWN
   [2] : FOX
   [3] : QUICK
   [4] : jumps
   [5] : over
   [6] : the
   [7] : lazy
   [8] : dog

After sorting a section of the Array using the reverse case-insensitive comparer:
   [0] : The
   [1] : QUICK
   [2] : FOX
   [3] : BROWN
   [4] : jumps
   [5] : over
   [6] : the
   [7] : lazy
   [8] : dog

After sorting the entire Array using the default comparer:
   [0] : BROWN
   [1] : dog
   [2] : FOX
   [3] : jumps
   [4] : lazy
   [5] : over
   [6] : QUICK
   [7] : the
   [8] : The

After sorting the entire Array using the reverse case-insensitive comparer:
   [0] : the
   [1] : The
   [2] : QUICK
   [3] : over
   [4] : lazy
   [5] : jumps
   [6] : FOX
   [7] : dog
   [8] : BROWN

*/
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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
Platforms

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.