IStructuralComparable IStructuralComparable IStructuralComparable IStructuralComparable Interface

Definição

Dá suporte à comparação estrutural de objetos da coleção.Supports the structural comparison of collection objects.

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

Exemplos

O exemplo a seguir cria uma matriz Tuple<T1,T2,T3,T4,T5,T6> de objetos que contém dados de população para três cidades dos EUA de 1960 a 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. O primeiro componente do sextuple é o nome da cidade.The sextuple's first component is the city name. Os cinco componentes restantes representam a população em intervalos de dez anos de 1960 a 2000.The remaining five components represent the population at ten-year intervals from 1960 to 2000.

A PopulationComparer classe fornece uma IComparer implementação que permite que a matriz de sextuples seja classificada por qualquer um de seus componentes.The PopulationComparer class provides an IComparer implementation that allows the array of sextuples to be sorted by any one of its components. Dois valores são fornecidos à PopulationComparer classe em seu construtor: a posição do componente que define a ordem de classificação e um valor booliano que indica se os objetos de tupla devem ser classificados em ordem crescente ou decrescente.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.

Em seguida, o exemplo exibe os elementos na matriz em ordem não classificada, classifica-os pelo terceiro componente (a população em 1970) e os exibe, em seguida, os classifica pelo sexto componente (a população em 2000) e os exibe.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. Observe que o exemplo não chama diretamente o CompareTo método.Note that the example does not directly call the CompareTo method. O método é chamado implicitamente pelo Sort(Array, IComparer) método para cada objeto de tupla na matriz.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)

Comentários

A IStructuralComparable interface permite que você implemente comparações personalizadas para membros da coleção.The IStructuralComparable interface enables you to implement customized comparisons for collection members. Ou seja, você pode definir precisamente o que significa para um objeto de coleção preceder, seguir ou ocorrer na mesma posição na ordem de classificação como um segundo objeto de coleção.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. Em seguida, você pode especificar que essa definição seja usada com um tipo de coleção IStructuralComparable que aceita a interface.You can then specify that this definition be used with a collection type that accepts the IStructuralComparable interface.

A interface tem um único membro, CompareTo, que determina se o objeto da coleção atual é menor que, igual ou maior que um segundo objeto na ordem de classificação.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. A comparação real dos membros ou elementos na instância atual com aqueles em um segundo objeto é executada por uma IComparer implementação de interface, que contém a definição de sua comparação personalizada.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.

Observação

A IStructuralComparable interface dá suporte apenas a comparações estruturais para classificação ou ordenação.The IStructuralComparable interface supports only structural comparisons for sorting or ordering. A IStructuralEquatable interface dá suporte a comparações personalizadas para igualdade estrutural.The IStructuralEquatable interface supports custom comparisons for structural equality.

O .NET Framework fornece dois comparadores padrão.The .NET Framework provides two default comparers. Um é retornado pela StructuralComparisons.StructuralComparer Propriedade; o outro é retornado Comparer<T>.Default pela propriedade.One is returned by the StructuralComparisons.StructuralComparer property; the other is returned by the Comparer<T>.Default property.

As classes de tupla genéricasTuple<T1>( Tuple<T1,T2>, Tuple<T1,T2,T3>, e assim por diante) IStructuralComparable e Array a classe fornecem implementações explícitas da interface.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. Convertendo (in C#) ou convertendo (em Visual Basic) a instância atual de uma matriz ou tupla em IStructuralComparable um valor de interface e IComparer fornecendo sua implementação como um argumento CompareTo para o método, você pode definir uma ordem de classificação personalizada para a matriz ou coleção.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. No entanto, você não chama CompareTo o método diretamente na maioria dos casos.However, you do not call the CompareTo method directly in most cases. Em vez disso CompareTo , o método é chamado por métodos de Sort(Array, IComparer)classificação, como.Instead, the CompareTo method is called by sorting methods such as Sort(Array, IComparer). Nesse caso, você define sua IComparer implementação e a passa como um argumento para um método de classificação ou construtor de classe do objeto de coleção.In this case, you define your IComparer implementation and pass it as an argument to a sorting method or collection object's class constructor. O CompareTo método com seu comparador personalizado é chamado automaticamente sempre que a coleção é classificada.The CompareTo method with your custom comparer is then called automatically whenever the collection is sorted.

Métodos

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

Determina se o objeto da coleção atual precede, ocorre na mesma posição ou segue a outro objeto na ordem de classificação.Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order.

Aplica-se a

Veja também