IStructuralComparable Interfejs

Definicja

Obsługuje porównanie strukturalne obiektów kolekcji.Supports the structural comparison of collection objects.

public interface class IStructuralComparable
public interface IStructuralComparable
type IStructuralComparable = interface
Public Interface IStructuralComparable
Pochodne

Przykłady

Poniższy przykład tworzy tablicę obiektów Tuple<T1,T2,T3,T4,T5,T6>, które zawierają dane populacji dla trzech miast USA od 1960 do 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. Pierwszy składnik Sextuple jest nazwą miasta.The sextuple's first component is the city name. Pozostałe pięć składników reprezentuje populację w okresach dziesięciu lat od 1960 do 2000.The remaining five components represent the population at ten-year intervals from 1960 to 2000.

Klasa PopulationComparer zapewnia implementację IComparer, która umożliwia posortowanie tablicy sextuples przez jeden z jego składników.The PopulationComparer class provides an IComparer implementation that allows the array of sextuples to be sorted by any one of its components. Dwie wartości są dostarczane do klasy PopulationComparer w jej konstruktorze: pozycja składnika definiująca porządek sortowania i wartość logiczna wskazująca, czy obiekty krotek mają być sortowane w kolejności rosnącej czy malejącej.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.

Przykład wyświetla elementy w tablicy w kolejności niesortowanej, sortuje je według trzeciego składnika (populacji w 1970) i wyświetla je, a następnie sortuje według szóstego składnika (populacja w 2000) i wyświetla je.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. Należy zauważyć, że przykład nie wywołuje bezpośrednio metody CompareTo.Note that the example does not directly call the CompareTo method. Metoda jest wywoływana niejawnie przez metodę Sort(Array, IComparer) dla każdego obiektu krotki w tablicy.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)

Uwagi

Interfejs IStructuralComparable umożliwia implementowanie niestandardowych porównań dla elementów członkowskich kolekcji.The IStructuralComparable interface enables you to implement customized comparisons for collection members. Oznacza to, że można zdefiniować dokładne znaczenie dla jednego obiektu kolekcji, aby poprzedzać, obserwować lub wystąpić w tym samym położeniu w kolejności sortowania jako drugi obiekt kolekcji.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. Następnie można określić, że ta definicja ma być używana z typem kolekcji akceptującym interfejs IStructuralComparable.You can then specify that this definition be used with a collection type that accepts the IStructuralComparable interface.

Interfejs ma jeden element członkowski, CompareTo, który określa, czy bieżący obiekt kolekcji jest mniejszy niż lub większy niż drugi obiekt w kolejności sortowania.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. Rzeczywiste porównanie elementów członkowskich lub elementów w bieżącym wystąpieniu z tymi w drugim obiekcie jest wykonywane przez implementację interfejsu IComparer, która zawiera definicję niestandardowego porównania.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.

Uwaga

Interfejs IStructuralComparable obsługuje tylko porównania strukturalne w celu sortowania lub porządkowania.The IStructuralComparable interface supports only structural comparisons for sorting or ordering. Interfejs IStructuralEquatable obsługuje niestandardowe porównania dla równości strukturalnej.The IStructuralEquatable interface supports custom comparisons for structural equality.

.NET Framework udostępnia dwa domyślne funkcje porównujące.The .NET Framework provides two default comparers. Jeden jest zwracany przez właściwość StructuralComparisons.StructuralComparer; drugi jest zwracany przez właściwość Comparer<T>.Default.One is returned by the StructuralComparisons.StructuralComparer property; the other is returned by the Comparer<T>.Default property.

Klasy kolekcji generycznej (Tuple<T1>, Tuple<T1,T2>, Tuple<T1,T2,T3>itd.) i Klasa Array zapewniają jawne implementacje interfejsu 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. Przez rzutowanie ( C#w) lub konwertowanie (w Visual Basic) bieżące wystąpienie tablicy lub krotki do wartości interfejsu IStructuralComparable i dostarczenie IComparer implementacji jako argumentu do metody CompareTo, można zdefiniować niestandardową kolejność sortowania dla tablicy lub kolekcji.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. Jednak Metoda CompareTo nie jest wywoływana bezpośrednio w większości przypadków.However, you do not call the CompareTo method directly in most cases. Zamiast tego Metoda CompareTo jest wywoływana przez sortowanie metod, takich jak Sort(Array, IComparer).Instead, the CompareTo method is called by sorting methods such as Sort(Array, IComparer). W takim przypadku należy zdefiniować implementację IComparer i przekazać ją jako argument do metody sortowania lub konstruktora klasy obiektu kolekcji.In this case, you define your IComparer implementation and pass it as an argument to a sorting method or collection object's class constructor. Metoda CompareTo z niestandardową funkcją porównującą jest wywoływana automatycznie za każdym razem, gdy kolekcja jest sortowana.The CompareTo method with your custom comparer is then called automatically whenever the collection is sorted.

Metody

CompareTo(Object, IComparer)

Określa, czy bieżący obiekt kolekcji poprzedza, występuje w tym samym położeniu co lub w kolejności sortowania.Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order.

Dotyczy

Zobacz też