Tuple<T1,T2>.IStructuralComparable.CompareTo(Object, IComparer) Tuple<T1,T2>.IStructuralComparable.CompareTo(Object, IComparer) Tuple<T1,T2>.IStructuralComparable.CompareTo(Object, IComparer) Method

Definição

Compara o objeto Tuple<T1,T2> atual com um objeto especificado usando um comparador especificado e retorna um inteiro que indica se o objeto atual está antes, depois ou na mesma posição do objeto especificado na ordem de classificação.Compares the current Tuple<T1,T2> 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

Parâmetros

other
Object Object Object

Um objeto a ser comparado com a instância atual.An object to compare with the current instance.

comparer
IComparer IComparer IComparer

Um objeto que fornece regras personalizadas para comparação.An object that provides custom rules for comparison.

Retornos

Um inteiro assinado que indica a posição relativa dessa instância e other na ordem de classificação, conforme mostrado na tabela a seguir.A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

ValorValue DescriçãoDescription
Um inteiro negativoA negative integer Esta instância precede other.This instance precedes other.
ZeroZero Esta instância e other têm a mesma posição na ordem de classificação.This instance and other have the same position in the sort order.
Um inteiro positivoA positive integer Esta instância segue other.This instance follows other.

Implementações

Exceções

other não é um objeto Tuple<T1,T2>.other is not a Tuple<T1,T2> object.

Exemplos

O exemplo a seguir cria uma matriz de Tuple<T1,T2> objetos que consistem em nome de um aluno e teste de pontuação.The following example creates an array of Tuple<T1,T2> objects that consist of a student's name and test score. Exibe o componente de cada tupla na matriz em ordem classificada, classifica a matriz e, em seguida, chama ToString para exibir o valor de cada tupla em ordem classificada.It displays the component of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display the value of each tuple in sorted order. Para classificar a matriz, o exemplo define um genérico ScoreComparer classe que implementa o IComparer interface e classifica o Tuple<T1,T2> objetos em ordem crescente pelo valor do seu componente de segundos em vez de seu primeiro componente.To sort the array, the example defines a generic ScoreComparer class that implements the IComparer interface and sorts the Tuple<T1,T2> objects in ascending order by the value of their second component rather than their first component. Observe que o exemplo não chama diretamente o IStructuralComparable.CompareTo método.Note that the example does not directly call the IStructuralComparable.CompareTo method. Este método é chamado implicitamente pelo método Array.Sort(Array, IComparer) para cada elemento na matriz.This method is called implicitly by the Array.Sort(Array, IComparer) method for each element in the array.

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

public class ScoreComparer<T1, T2> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2> tX = x as Tuple<T1,T2>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2> tY = y as Tuple<T1, T2>;
         return Comparer<T2>.Default.Compare(tX.Item2, tY.Item2);             
      }
   }
}

public class Example
{
   public static void Main()
   {
      Tuple<string, Nullable<int>>[] scores = 
                    { new Tuple<string, Nullable<int>>("Jack", 78),
                      new Tuple<string, Nullable<int>>("Abbey", 92), 
                      new Tuple<string, Nullable<int>>("Dave", 88),
                      new Tuple<string, Nullable<int>>("Sam", 91), 
                      new Tuple<string, Nullable<int>>("Ed", null),
                      new Tuple<string, Nullable<int>>("Penelope", 82),
                      new Tuple<string, Nullable<int>>("Linda", 99),
                      new Tuple<string, Nullable<int>>("Judith", 84) };

      Console.WriteLine("The values in unsorted order:");
      foreach (var score in scores)
         Console.WriteLine(score.ToString());

      Console.WriteLine();

      Array.Sort(scores, new ScoreComparer<string, Nullable<int>>());

      Console.WriteLine("The values in sorted order:");
      foreach (var score in scores)
         Console.WriteLine(score.ToString());
   }
}
// The example displays the following output;
//       The values in unsorted order:
//       (Jack, 78)
//       (Abbey, 92)
//       (Dave, 88)
//       (Sam, 91)
//       (Ed, )
//       (Penelope, 82)
//       (Linda, 99)
//       (Judith, 84)
//       
//       The values in sorted order:
//       (Ed, )
//       (Jack, 78)
//       (Penelope, 82)
//       (Judith, 84)
//       (Dave, 88)
//       (Sam, 91)
//       (Abbey, 92)
//       (Linda, 99)
Imports System.Collections
Imports System.Collections.Generic

Public Class ScoreComparer(Of T1, T2) : Implements IComparer
   Public Function Compare(x As Object, y As Object) As Integer _
                   Implements IComparer.Compare
      Dim tX As Tuple(Of T1, T2) = TryCast(x, Tuple(Of T1, T2))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY As Tuple(Of T1, T2) = DirectCast(y, Tuple(Of T1, T2))
         Return Comparer(Of T2).Default.Compare(tx.Item2, tY.Item2)             
      End If
   End Function
End Class

Module Example
   Public Sub Main()
      Dim scores() As Tuple(Of String, Nullable(Of Integer)) = 
                      { New Tuple(Of String, Nullable(Of Integer))("Jack", 78),
                        New Tuple(Of String, Nullable(Of Integer))("Abbey", 92), 
                        New Tuple(Of String, Nullable(Of Integer))("Dave", 88),
                        New Tuple(Of String, Nullable(Of Integer))("Sam", 91), 
                        New Tuple(Of String, Nullable(Of Integer))("Ed", Nothing),
                        New Tuple(Of String, Nullable(Of Integer))("Penelope", 82),
                        New Tuple(Of String, Nullable(Of Integer))("Linda", 99),
                        New Tuple(Of String, Nullable(Of Integer))("Judith", 84) }

      Console.WriteLine("The values in unsorted order:")
      For Each score In scores
         Console.WriteLine(score.ToString())
      Next
      Console.WriteLine()

      Array.Sort(scores, New ScoreComparer(Of String, Nullable(Of Integer))())

      Console.WriteLine("The values in sorted order:")
      For Each score In scores
         Console.WriteLine(score.ToString())
      Next
   End Sub
End Module
' The example displays the following output;
'       The values in unsorted order:
'       (Jack, 78)
'       (Abbey, 92)
'       (Dave, 88)
'       (Sam, 91)
'       (Ed, )
'       (Penelope, 82)
'       (Linda, 99)
'       (Judith, 84)
'       
'       The values in sorted order:
'       (Ed, )
'       (Jack, 78)
'       (Penelope, 82)
'       (Judith, 84)
'       (Dave, 88)
'       (Sam, 91)
'       (Abbey, 92)
'       (Linda, 99)

Comentários

Este membro é uma implementação do membro de interface explícita.This member is an explicit interface member implementation. Ele só pode ser usado quando a instância de Tuple<T1,T2> é convertida em uma interface de IStructuralComparable.It can be used only when the Tuple<T1,T2> instance is cast to an IStructuralComparable interface.

Embora esse método pode ser chamado diretamente, ele é mais comumente chamado por coleção, que incluem métodos de classificação IComparer parâmetros para ordenar os membros de uma coleção.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. Por exemplo, ele é chamado pelo método Array.Sort(Array, IComparer) e pelo método Add de um objeto SortedList que é instanciado usando-se o construtor 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.

Cuidado

O IStructuralComparable.CompareTo método é destinado para uso em operações de classificação.The IStructuralComparable.CompareTo method is intended for use in sorting operations. Ele não deve ser usado quando a finalidade principal de uma comparação é determinar se dois objetos são iguais.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Para determinar se dois objetos são iguais, chame o IStructuralEquatable.Equals método.To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

Aplica-se a

Veja também