Tuple<T1,T2,T3,T4,T5,T6,T7>.IStructuralComparable.CompareTo(Object, IComparer) Метод

Определение

Сравнивает текущий объект Tuple<T1,T2,T3,T4,T5,T6,T7> с указанным объектом, используя заданный компаратор, и возвращает целое число, которое показывает положение текущего объекта относительно указанного объекта в порядке сортировки: перед объектом, после него или в той же позиции.Compares the current Tuple<T1,T2,T3,T4,T5,T6,T7> 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

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

comparer
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,T6,T7>.other is not a Tuple<T1,T2,T3,T4,T5,T6,T7> object.

Примеры

В следующем примере создается массив объектов Tuple<T1,T2,T3,T4,T5,T6,T7>, содержащих данные о населении для трех городов США с 1950 до 2000.The following example creates an array of Tuple<T1,T2,T3,T4,T5,T6,T7> objects that contains population data for three U.S. cities from 1950 to 2000. Первым компонентом из семи компонентов является название города.The septuple's first component is the city name. Оставшиеся пять компонентов представляют совокупность за 10 лет с 1950 до 2000.The remaining five components represent the population at 10-year intervals from 1950 to 2000.

Класс PopulationComparer предоставляет реализацию IComparer, которая позволяет сортировать массив септуплес по любому из его компонентов.The PopulationComparer class provides an IComparer implementation that allows the array of septuples to be sorted by any one of its components. В конструкторе класса PopulationComparer предоставляются два значения: расположение компонента, определяющего порядок сортировки, и значение Boolean, указывающее, должны ли объекты кортежа сортироваться в порядке возрастания или убывания.Two values are provided to the PopulationComparer class in its constructor: The position of the component that defines the sort order, and a Boolean value that indicates whether the tuple objects should be sorted in ascending or descending order.

Затем в этом примере элементы массива отображаются в несортированном порядке, сортируются по третьему компоненту (заполнение в 1960) и отображаются, а затем сортируются по шестому компоненту (заполнение в 1990) и отображаются.The example then displays the elements in the array in unsorted order, sorts them by the third component (the population in 1960) and displays them, and then sorts them by the sixth component (the population in 1990) and displays them.

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

public class PopulationComparer<T1, T2, T3, T4, T5, T6, T7> : IComparer
{
   private int itemPosition;
   private int multiplier = -1;

   public PopulationComparer(int component) : this(component, true)
   { }

   public PopulationComparer(int component, bool descending)
   {
      if (! descending) multiplier = 1;

      if (component <= 0 || component > 7)
         throw new ArgumentException("The component argument is out of range.");

      itemPosition = component;
   }

   public int Compare(object x, object y)
   {
      Tuple<T1, T2, T3, T4, T5, T6, T7> tX = x as Tuple<T1, T2, T3, T4, T5, T6, T7>;
      if (tX == null)
      {
         return 0;
      }
      else
      {
         Tuple<T1, T2, T3, T4, T5, T6, T7> tY = y as Tuple<T1, T2, T3, T4, T5, T6, T7>;
         switch (itemPosition)
         {
            case 1:
               return Comparer<T1>.Default.Compare(tX.Item1, tY.Item1) * multiplier;
            case 2:
               return Comparer<T2>.Default.Compare(tX.Item2, tY.Item2) * multiplier;
            case 3:
               return Comparer<T3>.Default.Compare(tX.Item3, tY.Item3) * multiplier;
            case 4:
               return Comparer<T4>.Default.Compare(tX.Item4, tY.Item4) * multiplier;
            case 5:
               return Comparer<T5>.Default.Compare(tX.Item5, tY.Item5) * multiplier;
            case 6:
               return Comparer<T6>.Default.Compare(tX.Item6, tY.Item6) * multiplier;
            case 7:
               return Comparer<T7>.Default.Compare(tX.Item7, tY.Item7) * multiplier;
            default:
               return Comparer<T1>.Default.Compare(tX.Item1, tY.Item1) * multiplier;
         }
      }
   }
}

public class Example
{
   public static void Main()
   {
      // Create array of sextuple with population data for three U.S.
      // cities, 1960-2000.
      Tuple<string, int, int, int, int, int, int>[] cities =
           { Tuple.Create("Los Angeles", 1970358, 2479015, 2816061, 2966850, 3485398, 3694820),
             Tuple.Create("New York", 7891957, 7781984, 7894862, 7071639, 7322564, 8008278),
             Tuple.Create("Chicago", 3620962, 3550904, 3366957, 3005072, 2783726, 2896016) };

      // Display array in unsorted order.
      Console.WriteLine("In unsorted order:");
      foreach (var city in cities)
         Console.WriteLine(city.ToString());
      Console.WriteLine();

      Array.Sort(cities, new PopulationComparer<string, int, int, int, int, int, int>(3));

      // Display array in sorted order.
      Console.WriteLine("Sorted by population in 1960:");
      foreach (var city in cities)
         Console.WriteLine(city.ToString());
      Console.WriteLine();

      Array.Sort(cities, new PopulationComparer<string, int, int, int, int, int, int>(6));

      // Display array in sorted order.
      Console.WriteLine("Sorted by population in 1990:");
      foreach (var city in cities)
         Console.WriteLine(city.ToString());
   }
}
// The example displays the following output:
//    In unsorted order:
//    (Los Angeles, 1970358, 2479015, 2816061, 2966850, 3485398, 3694820)
//    (New York, 7891957, 7781984, 7894862, 7071639, 7322564, 8008278)
//    (Chicago, 3620962, 3550904, 3366957, 3005072, 2783726, 2896016)
//    
//    Sorted by population in 1960:
//    (New York, 7891957, 7781984, 7894862, 7071639, 7322564, 8008278)
//    (Chicago, 3620962, 3550904, 3366957, 3005072, 2783726, 2896016)
//    (Los Angeles, 1970358, 2479015, 2816061, 2966850, 3485398, 3694820)
//    
//    Sorted by population in 1990:
//    (New York, 7891957, 7781984, 7894862, 7071639, 7322564, 8008278)
//    (Los Angeles, 1970358, 2479015, 2816061, 2966850, 3485398, 3694820)
//    (Chicago, 3620962, 3550904, 3366957, 3005072, 2783726, 2896016)
Imports System.Collections
Imports System.Collections.Generic

Public Class PopulationComparer(Of T1, T2, T3, T4, T5, T6, T7) : Implements IComparer
   Private itemPosition As Integer
   Private multiplier As Integer = -1
      
   Public Sub New(component As Integer)
      Me.New(component, True)
   End Sub
   
   Public Sub New(component As Integer, descending As Boolean)
      If Not descending Then multiplier = 1
      
      If component <= 0 Or component > 7 Then 
         Throw New ArgumentException("The component argument is out of range.")
      End If
      itemPosition = component
   End Sub 
   
   Public Function Compare(x As Object, y As Object) As Integer _
                   Implements IComparer.Compare
 
      Dim tX As Tuple(Of T1, T2, T3, T4, T5, T6, T7) = TryCast(x, Tuple(Of T1, T2, T3, T4, T5, T6, T7))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY As Tuple(Of T1, T2, T3, T4, T5, T6, T7) = DirectCast(y, Tuple(Of T1, T2, T3, T4, T5, T6, T7))
         Select Case itemPosition
            Case 1
               Return Comparer(Of T1).Default.Compare(tX.Item1, tY.Item1) * multiplier
            Case 2
               Return Comparer(Of T2).Default.Compare(tX.Item2, tY.Item2) * multiplier
            Case 3
               Return Comparer(Of T3).Default.Compare(tX.Item3, tY.Item3) * multiplier
            Case 4
               Return Comparer(Of T4).Default.Compare(tX.Item4, tY.Item4) * multiplier
            Case 5
               Return Comparer(Of T5).Default.Compare(tX.Item5, tY.Item5) * multiplier
            Case 6
               Return Comparer(Of T6).Default.Compare(tX.Item6, tY.Item6) * multiplier
            Case 7
               Return Comparer(Of T7).Default.Compare(tX.Item7, tY.Item7) * multiplier
            ' This should never be reached.
            Case Else
               Return 0
         End Select      
      End If
   End Function
End Class

Module Example
   Public Sub Main()
      ' Create array of sextuple with population data for three U.S. 
      ' cities, 1950-2000.
      Dim cities() = 
          { Tuple.Create("Los Angeles", 1970358, 2479015, 2816061, 2966850, 3485398, 3694820),
            Tuple.Create("New York", 7891957, 7781984, 7894862, 7071639, 7322564, 8008278),  
            Tuple.Create("Chicago", 3620962, 3550904, 3366957, 3005072, 2783726, 2896016) } 
      
      ' Display array in unsorted order.
      Console.WriteLine("In unsorted order:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
      Console.WriteLine()
      
      Array.Sort(cities, New PopulationComparer(Of String, Integer, Integer, Integer, Integer, Integer, Integer)(3)) 
                           
      ' Display array in sorted order.
      Console.WriteLine("Sorted by population in 1960:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
      Console.WriteLine()
      
      Array.Sort(cities, New PopulationComparer(Of String, Integer, Integer, Integer, Integer, Integer, Integer)(6))
                           
      ' Display array in sorted order.
      Console.WriteLine("Sorted by population in 1990:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
   End Sub
End Module
' The example displays the following output:
'    In unsorted order:
'    (Los Angeles, 1970358, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (New York, 7891957, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Chicago, 3620962, 3550904, 3366957, 3005072, 2783726, 2896016)
'    
'    Sorted by population in 1960:
'    (New York, 7891957, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Chicago, 3620962, 3550904, 3366957, 3005072, 2783726, 2896016)
'    (Los Angeles, 1970358, 2479015, 2816061, 2966850, 3485398, 3694820)
'    
'    Sorted by population in 1990:
'    (New York, 7891957, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Los Angeles, 1970358, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (Chicago, 3620962, 3550904, 3366957, 3005072, 2783726, 2896016)

Комментарии

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

Этот метод позволяет определять пользовательские сравнения объектов Tuple<T1,T2,T3,T4,T5,T6,T7>.This method lets you define customized comparisons of Tuple<T1,T2,T3,T4,T5,T6,T7> objects. Например, этот метод можно использовать для упорядочивания Tuple<T1,T2,T3,T4,T5,T6,T7> объектов на основе значения определенного компонента.For example, you can use this method to order Tuple<T1,T2,T3,T4,T5,T6,T7> objects based on the value of a specific component.

Несмотря на то, что этот метод можно вызывать напрямую, он чаще всего вызывается методами сортировки коллекций, которые включают 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.To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

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

Дополнительно