IStructuralComparable IStructuralComparable IStructuralComparable IStructuralComparable Interface

Определение

Поддерживает структурное сравнение объектов коллекции.Supports the structural comparison of collection objects.

public interface class IStructuralComparable
public interface IStructuralComparable
type IStructuralComparable = interface
Public Interface IStructuralComparable
Производный

Примеры

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

PopulationComparer КлассIComparer предоставляет реализацию, которая позволяет сортировать массив секступлес по любому из его компонентов.The PopulationComparer class provides an IComparer implementation that allows the array of sextuples to be sorted by any one of its components. В конструкторе передаются PopulationComparer два значения: расположение компонента, определяющего порядок сортировки, и логическое значение, указывающее, сортируются ли объекты кортежа в порядке возрастания или убывания.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.

Затем в этом примере элементы массива отображаются в несортированном порядке, сортируются по третьему компоненту (заполнение в 1970) и отображаются, а затем сортируются по шестому компоненту (заполнение в 2000) и отображаются.The example then displays the elements in the array in unsorted order, sorts them by the third component (the population in 1970) and displays them, and then sorts them by the sixth component (the population in 2000) and displays them. Обратите внимание, что в этом примере CompareTo метод не вызывается напрямую.Note that the example does not directly call the CompareTo method. Метод вызывается неявно Sort(Array, IComparer) методом для каждого объекта кортежа в массиве.The method is called implicitly by the Sort(Array, IComparer) method for each tuple object in the array.

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

public class PopulationComparer<T1, T2, T3, T4, T5, T6> : 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 > 6)
         throw new ArgumentException("The component argument is out of range.");

      itemPosition = component;
   }

   public int Compare(object x, object y)
   {
      var tX = x as Tuple<T1, T2, T3, T4, T5, T6>;
      if (tX == null)
      {
         return 0;
      }
      else
      {
         var tY = y as Tuple<T1, T2, T3, T4, T5, T6>;
         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;
            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>[] cities =
           { Tuple.Create("Los Angeles", 2479015, 2816061, 2966850, 3485398, 3694820),
             Tuple.Create("New York", 7781984, 7894862, 7071639, 7322564, 8008278),
             Tuple.Create("Chicago", 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>(3));

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

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

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

Public Class PopulationComparer(Of T1, T2, T3, T4, T5, T6) : 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 > 6 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 = TryCast(x, Tuple(Of T1, T2, T3, T4, T5, T6))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY = DirectCast(y, Tuple(Of T1, T2, T3, T4, T5, T6))
         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
            ' This should never happen.
            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, 1960-2000.
      Dim cities() = 
          { Tuple.Create("Los Angeles", 2479015, 2816061, 2966850, 3485398, 3694820),
            Tuple.Create("New York", 7781984, 7894862, 7071639, 7322564, 8008278),  
            Tuple.Create("Chicago", 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)(3)) 
                           
      ' Display array in sorted order.
      Console.WriteLine("Sorted by population in 1970:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
      Console.WriteLine()
      
      Array.Sort(cities, New PopulationComparer(Of String, Integer, Integer, Integer, Integer, Integer)(6))
                           
      ' Display array in sorted order.
      Console.WriteLine("Sorted by population in 2000:")
      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, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
'    
'    Sorted by population in 1970:
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
'    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
'    
'    Sorted by population in 2000:
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)

Комментарии

IStructuralComparable Интерфейс позволяет реализовать пользовательские сравнения для элементов коллекции.The IStructuralComparable interface enables you to implement customized comparisons for collection members. Иными словами, можно точно определить, что означает для одного объекта коллекции, который должен предшествовать, следовать или находиться в том же положении в порядке сортировки, что и второй объект коллекции.That is, you can define precisely what it means for one collection object to precede, follow, or occur in the same position in the sort order as a second collection object. Затем можно указать, что это определение должно использоваться с типом коллекции, который принимает IStructuralComparable интерфейс.You can then specify that this definition be used with a collection type that accepts the IStructuralComparable interface.

Интерфейс содержит один элемент CompareTo, который определяет, является ли текущий объект коллекции меньшим, равным или большим, чем второй объект в порядке сортировки.The interface has a single member, CompareTo, which determines whether the current collection object is less than, equal to, or greater than a second object in the sort order. Фактическое сравнение элементов или элементов в текущем экземпляре с элементами во втором объекте IComparer осуществляется реализацией интерфейса, которая содержит определение пользовательского сравнения.The actual comparison of the members or elements in the current instance with those in a second object is performed by an IComparer interface implementation, which contains the definition of your custom comparison.

Примечание

IStructuralComparable Интерфейс поддерживает только структурные сравнения для сортировки или упорядочения.The IStructuralComparable interface supports only structural comparisons for sorting or ordering. IStructuralEquatable Интерфейс поддерживает пользовательские сравнения для структурного равенства.The IStructuralEquatable interface supports custom comparisons for structural equality.

.NET Framework предоставляет два компаратора по умолчанию.The .NET Framework provides two default comparers. Одна из них возвращается StructuralComparisons.StructuralComparer свойством, а другая возвращается Comparer<T>.Default свойством.One is returned by the StructuralComparisons.StructuralComparer property; the other is returned by the Comparer<T>.Default property.

Универсальные классы кортежейTuple<T1>( Tuple<T1,T2>, Tuple<T1,T2,T3>, и т. д.) Array и класс предоставляют явные реализации IStructuralComparable интерфейса.The generic tuple classes (Tuple<T1>, Tuple<T1,T2>, Tuple<T1,T2,T3>, and so on) and the Array class provide explicit implementations of the IStructuralComparable interface. Путем приведения ( C#в) или преобразования (в Visual Basic) текущего экземпляра массива или кортежа в IStructuralComparable IComparer значение интерфейса и предоставления реализации в качестве аргумента для CompareTo метода можно определить пользовательский порядок сортировки. для массива или коллекции.By casting (in C#) or converting (in Visual Basic) the current instance of an array or tuple to an IStructuralComparable interface value and providing your IComparer implementation as an argument to the CompareTo method, you can define a custom sort order for the array or collection. Однако в большинстве случаев CompareTo метод не вызывается напрямую.However, you do not call the CompareTo method directly in most cases. Вместо этого Sort(Array, IComparer)метод вызывается такими методами сортировки, как. CompareToInstead, the CompareTo method is called by sorting methods such as Sort(Array, IComparer). В этом случае необходимо определить IComparer реализацию и передать ее в качестве аргумента в конструктор класса метода сортировки или объекта коллекции.In this case, you define your IComparer implementation and pass it as an argument to a sorting method or collection object's class constructor. CompareTo Метод с пользовательским компаратором затем вызывается автоматически при сортировке коллекции.The CompareTo method with your custom comparer is then called automatically whenever the collection is sorted.

Методы

CompareTo(Object, IComparer) CompareTo(Object, IComparer) CompareTo(Object, IComparer) CompareTo(Object, IComparer)

Определяет позицию текущего объекта коллекции относительно другого объекта в порядке сортировки (находится перед другим объектов, на одной позиции с ним или после другого объекта).Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order.

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

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