Tuple<T1,T2,T3,T4,T5>.IComparable.CompareTo(Object) Method

Definition

Сравнивает текущий объект Tuple<T1,T2,T3,T4,T5> с заданным объектом и возвращает целое число, указывающее, находится ли текущий объект в той же позиции, что и указанный объект, после него или перед ним в порядке сортировки.Compares the current Tuple<T1,T2,T3,T4,T5> object to a specified object and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.

 virtual int System.IComparable.CompareTo(System::Object ^ obj) = IComparable::CompareTo;
int IComparable.CompareTo (object obj);
abstract member System.IComparable.CompareTo : obj -> int
override this.System.IComparable.CompareTo : obj -> int
Function CompareTo (obj As Object) As Integer Implements IComparable.CompareTo

Parameters

obj
Object

Объект для сравнения с текущим экземпляром.An object to compare with the current instance.

Returns

Int32

Целое число со знаком, определяющее относительное положение экземпляра и параметра obj в порядке сортировки, как показано в следующей таблице.A signed integer that indicates the relative position of this instance and obj in the sort order, as shown in the following table.

ЗначениеValue DescriptionDescription
Отрицательное целое числоA negative integer Данный экземпляр предшествует параметру obj.This instance precedes obj.
НольZero У этого экземпляра та же позиция в порядке сортировки, что и у obj.This instance and obj have the same position in the sort order.
Положительное целое числоA positive integer Данный экземпляр стоит после параметра obj.This instance follows obj.

Implements

Exceptions

obj не является объектом Tuple<T1,T2,T3,T4,T5>.obj is not a Tuple<T1,T2,T3,T4,T5> object.

Examples

В следующем примере создается массив объектов Tuple<T1,T2,T3,T4,T5>, содержащих статистику карьеры для выполнения резервного копирования в американском футболе.The following example creates an array of Tuple<T1,T2,T3,T4,T5> objects that contain career statistics for running backs in American professional football. Пять компонентов состоят из названия игрока, числа игр, в которых он воспроизводился, числа переданных или попыток, общего количества полученного объема и количества таучдовнс.The five components consist of the player's name, the number of games in which he played, the number of carries or attempts, the total number of yards gained, and the number of touchdowns scored. В примере отображаются компоненты каждого кортежа в массиве без сортировки, выполняется сортировка массива, а затем вызывается ToString для отображения каждого кортежа в отсортированном порядке.The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display each tuple in sorted order. Выходные данные показывают, что массив был отсортирован по имени, который является первым компонентом.The output shows that the array has been sorted by name, which is the first component. Обратите внимание, что в примере не вызывается метод IComparable.CompareTo напрямую.Note that the example does not directly call the IComparable.CompareTo method. Этот метод вызывается неявно методом Sort(Array) для каждого элемента в массиве.This method is called implicitly by the Sort(Array) method for each element in the array.

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      // Organization of runningBacks 5-tuple:
      //    Component 1: Player name
      //    Component 2: Number of games played
      //    Component 3: Number of attempts (carries)
      //    Component 4: Number of yards gained 
      //    Component 5: Number of touchdowns   
      Tuple<string, int, int, int, int>[] runningBacks =
           { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
             Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
             Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
             Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
             Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) }; 

      // Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
      Console.WriteLine();
      
      // Sort the array
      Array.Sort(runningBacks);
      
      // Display the array in sorted order.
      Console.WriteLine("The values in sorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
   }
}
// The example displays the following output:
//       The values in unsorted order:
//       (Payton, Walter, 190, 3838, 16726, 110)
//       (Sanders, Barry, 153, 3062, 15269, 99)
//       (Brown, Jim, 118, 2359, 12312, 106)
//       (Dickerson, Eric, 144, 2996, 13259, 90)
//       (Faulk, Marshall, 176, 2836, 12279, 100)
//       
//       The values in sorted order:
//       (Brown, Jim, 118, 2359, 12312, 106)
//       (Dickerson, Eric, 144, 2996, 13259, 90)
//       (Faulk, Marshall, 176, 2836, 12279, 100)
//       (Payton, Walter, 190, 3838, 16726, 110)
//       (Sanders, Barry, 153, 3062, 15269, 99)
Imports System.Collections.Generic

Module Example
   Public Sub Main()
      ' Organization of runningBacks 5-tuple:
      '    Component 1: Player name
      '    Component 2: Number of games played
      '    Component 3: Number of attempts (carries)
      '    Component 4: Number of yards gained 
      '    Component 5: Number of touchdowns   
      Dim runningBacks() =
          { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
            Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
            Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
            Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
            Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) } 

      ' Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:")
      For Each runningBack In runningBacks
         Console.WriteLine(runningBack.ToString())
      Next
      Console.WriteLine()
      
      ' Sort the array
      Array.Sort(runningBacks)
      
      ' Display the array in sorted order.
      Console.WriteLine("The values in sorted order:")
      For Each runningBack In runningBacks
         Console.WriteLine(runningBack.ToString())
      Next
   End Sub
End Module
' The example displays the following output:
'       The values in unsorted order:
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Faulk, Marshall, 176, 2836, 12279, 100)
'       
'       The values in sorted order:
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Faulk, Marshall, 176, 2836, 12279, 100)
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)

Remarks

Это член является явной реализацией члена интерфейса.This member is an explicit interface member implementation. Он может использоваться, только если экземпляр Tuple<T1,T2,T3,T4,T5> приведен к типу интерфейса IComparable.It can be used only when the Tuple<T1,T2,T3,T4,T5> instance is cast to an IComparable interface.

Этот метод обеспечивает реализацию IComparable.CompareTo для класса Tuple<T1,T2,T3,T4,T5>.This method provides the IComparable.CompareTo implementation for the Tuple<T1,T2,T3,T4,T5> class. Несмотря на то, что метод можно вызывать напрямую, он чаще всего вызывается перегрузками методов сортировки коллекции по умолчанию, таких как Array.Sort(Array) и SortedList.Add, для упорядочивания элементов коллекции.Although the method can be called directly, it is most commonly called by the default overloads of collection-sorting methods, such as Array.Sort(Array) and SortedList.Add, to order the members of a collection.

Caution

Метод IComparable.CompareTo предназначен для использования в операциях сортировки.The IComparable.CompareTo method is intended for use in sorting operations. Его не следует использовать, если основной целью сравнения является определение того, равны ли два объекта.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Чтобы определить, равны ли два объекта, вызовите метод Tuple<T1,T2,T3,T4,T5>.Equals(Object).To determine whether two objects are equal, call the Tuple<T1,T2,T3,T4,T5>.Equals(Object) method.

Метод IComparable.CompareTo(Object) использует компаратор объектов по умолчанию для сравнения каждого компонента.The IComparable.CompareTo(Object) method uses the default object comparer to compare each component.

Applies to

See also