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

Определение

Сравнивает текущий объект Tuple<T1,T2,T3,T4,T5> с указанным объектом, используя заданный компаратор, и возвращает целое число, которое показывает положение текущего объекта относительно указанного объекта в порядке сортировки: перед объектом, после него или в той же позиции.Compares the current Tuple<T1,T2,T3,T4,T5> object to a specified object by using a specified comparer 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.Collections.IStructuralComparable.CompareTo(System::Object ^ other, System::Collections::IComparer ^ comparer) = System::Collections::IStructuralComparable::CompareTo;
int IStructuralComparable.CompareTo (object other, System.Collections.IComparer comparer);
Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

Параметры

other
Object Object Object

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

comparer
IComparer IComparer IComparer

Объект, предоставляющий настраиваемые правила для сравнения.An object that provides custom rules for comparison.

Возвраты

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

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

Реализации

Исключения

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

Примеры

В следующем примере создается массив Tuple<T1,T2,T3,T4,T5> объектов, содержащих статистические данные карьеры для выполнения резервного копирования в американском футболе.The following example creates an array of Tuple<T1,T2,T3,T4,T5> objects that contain career statistical data for running backs in American professional football. Компоненты из пяти кортежей состоят из названия игрока, числа игр, в которых он воспроизводился, числа переданных или попыток, общего количества полученных водопоказатели и количества таучдовнс.The 5-tuple's 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. Чтобы отсортировать массив, в примере определяется универсальный YardsGained класс, IComparer реализующий Tuple<T1,T2,T3,T4,T5> интерфейс, и сортируются объекты в убывающем порядке по значению их четвертого компонента (полученного от метра), а не по первому компоненту.To sort the array, the example defines a generic YardsGained class that implements the IComparer interface and sorts the Tuple<T1,T2,T3,T4,T5> objects in descending order by the value of their fourth component (yards gained) rather than by their first component. Обратите внимание, что в этом примере IStructuralComparable.CompareTo метод не вызывается напрямую.Note that the example does not directly call the IStructuralComparable.CompareTo method. Этот метод вызывается неявно Array.Sort(Array, IComparer) методом для каждого элемента в массиве.This method is called implicitly by the Array.Sort(Array, IComparer) method for each element in the array.

using System;
using System.Collections;
using System.Collections.Generic;

public class YardsGained<T1, T2, T3, T4, T5> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2, T3, T4, T5> tX = x as Tuple<T1, T2, T3, T4, T5>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2, T3, T4, T5> tY = y as Tuple<T1, T2, T3, T4, T5>;
         return -1 * Comparer<T4>.Default.Compare(tX.Item4, tY.Item4);             
      }
   }
}

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, new YardsGained<string, int, int, int, int>());
      
      // 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
Imports System.Collections.Generic

Public Class YardsGained(Of T1, T2, T3, T4, T5) : Implements IComparer
   Public Function Compare(x As Object, y As Object) As Integer _
                   Implements IComparer.Compare
      Dim tX As Tuple(Of T1, T2, T3, T4, T5) = TryCast(x, Tuple(Of T1, T2, T3, T4, T5))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY As Tuple(Of T1, T2, T3, T4, T5) = DirectCast(y, Tuple(Of T1, T2, T3, T4, T5))
         Return -1 * Comparer(Of T4).Default.Compare(tx.Item4, tY.Item4)             
      End If
   End Function
End Class

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, New YardsGained(Of String, Integer, Integer, Integer, Integer)())
      
      ' 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:
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Faulk, Marshall, 176, 2836, 12279, 100)

Комментарии

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

Несмотря на то, что этот метод можно вызывать напрямую, он чаще всего вызывается методами сортировки коллекций IComparer , которые включают параметры для упорядочения элементов коллекции.Although this method can be called directly, it is most commonly called by collection-sorting methods that include IComparer parameters to order the members of a collection. Например, Array.Sort(Array, IComparer) метод вызывается методом Add и методом SortedList SortedList.SortedList(IComparer) объекта, экземпляр которого создается с помощью конструктора.For example, it is called by the Array.Sort(Array, IComparer) method and the Add method of a SortedList object that is instantiated by using the SortedList.SortedList(IComparer) constructor.

Внимание!

IStructuralComparable.CompareTo Метод предназначен для использования в операциях сортировки.The IStructuralComparable.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. Чтобы определить, равны ли два объекта, вызовите IStructuralEquatable.Equals(Object, IEqualityComparer) метод.To determine whether two objects are equal, call the IStructuralEquatable.Equals(Object, IEqualityComparer) method.

Применяется к