IStructuralComparable IStructuralComparable IStructuralComparable IStructuralComparable Interface

Definice

Podporuje strukturální porovnání objektů kolekce.Supports the structural comparison of collection objects.

public interface class IStructuralComparable
public interface IStructuralComparable
type IStructuralComparable = interface
Public Interface IStructuralComparable
Odvozené

Příklady

Následující příklad vytvoří pole Tuple<T1,T2,T3,T4,T5,T6> objektů, které obsahují data populace pro tři města 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. První komponentou sextuple je název města.The sextuple's first component is the city name. Zbývající pět součástí představuje populaci v intervalech deseti let od 1960 do 2000.The remaining five components represent the population at ten-year intervals from 1960 to 2000.

PopulationComparer TřídaIComparer poskytuje implementaci, která umožňuje řazení pole sextuples pomocí kterékoli z jeho komponent.The PopulationComparer class provides an IComparer implementation that allows the array of sextuples to be sorted by any one of its components. V konstruktoru PopulationComparer třídy jsou k dispozici dvě hodnoty: pozice komponenty, která definuje pořadí řazení, a logickou hodnotu, která určuje, zda mají být objekty řazené kolekce členů seřazeny vzestupně nebo sestupně.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.

Příklad poté zobrazí prvky v poli v neseřazeném pořadí, seřadí je třetí komponentou (populace v 1970) a zobrazí je a pak je seřadí podle šesté součásti (populace v 2000) a zobrazí 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. Všimněte si, že tento příklad přímo nevolá CompareTo metodu.Note that the example does not directly call the CompareTo method. Metoda je volána implicitně Sort(Array, IComparer) metodou pro každý objekt řazené kolekce členů v poli.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)

Poznámky

IStructuralComparable Rozhraní umožňuje implementovat přizpůsobené porovnání pro členy kolekce.The IStructuralComparable interface enables you to implement customized comparisons for collection members. To znamená, že můžete přesně definovat, co znamená pro jeden objekt kolekce před, sledovat nebo nacházet ve stejné pozici v pořadí řazení jako druhý objekt kolekce.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. Pak můžete zadat, aby se tato definice použila s typem kolekce, který přijímá IStructuralComparable rozhraní.You can then specify that this definition be used with a collection type that accepts the IStructuralComparable interface.

Rozhraní má jediný člen, CompareTo, který určuje, zda je aktuální objekt kolekce menší než, rovno nebo větší než druhý objekt v pořadí řazení.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. Aktuální porovnání členů nebo prvků v aktuální instanci s hodnotami v druhém objektu je prováděno IComparer implementací rozhraní, které obsahuje definici vlastního porovnání.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.

Poznámka

IStructuralComparable Rozhraní podporuje pouze strukturální porovnání pro řazení nebo řazení.The IStructuralComparable interface supports only structural comparisons for sorting or ordering. IStructuralEquatable Rozhraní podporuje vlastní porovnávání pro strukturální rovnost.The IStructuralEquatable interface supports custom comparisons for structural equality.

.NET Framework poskytuje dva výchozí porovnávače.The .NET Framework provides two default comparers. Jedno je vráceno StructuralComparisons.StructuralComparer vlastností; druhá je vrácena Comparer<T>.Default vlastností.One is returned by the StructuralComparisons.StructuralComparer property; the other is returned by the Comparer<T>.Default property.

Obecné třídy řazené kolekceTuple<T1>členů Tuple<T1,T2>( Tuple<T1,T2,T3>,, a tak dále) IStructuralComparable a Array třídu poskytují explicitní implementace rozhraní.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. Přetypováním ( C#v) nebo převodem (v Visual Basic) aktuální instance pole nebo řazené kolekce členů IStructuralComparable na IComparer hodnotu rozhraní a poskytnutím implementace jako argumentu CompareTo metody můžete definovat vlastní pořadí řazení. pro pole nebo kolekci.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 Metodu však Nevolejte přímo ve většině případů.However, you do not call the CompareTo method directly in most cases. Místo toho Sort(Array, IComparer)je metodavolánapomocímetodřazeníCompareTo , jako je.Instead, the CompareTo method is called by sorting methods such as Sort(Array, IComparer). V tomto případě definujete IComparer implementaci a předáte ji jako argument metodě řazení nebo konstruktoru třídy objektu kolekce.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 Metoda s vlastní porovnávací metodou je pak volána automaticky při každém seřazení kolekce.The CompareTo method with your custom comparer is then called automatically whenever the collection is sorted.

Metody

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

Určuje, zda aktuální objekt kolekce předchází, probíhá ve stejné pozici jako nebo následuje za jiným objektem v pořadí řazení.Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order.

Platí pro

Viz také