Tuple<T1,T2,T3,T4,T5>.IStructuralComparable.CompareTo(Object, IComparer) Método

Definição

Compara o objeto Tuple<T1,T2,T3,T4,T5> 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,T3,T4,T5> 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);
abstract member System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int
override this.System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int
Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

Parâmetros

other
Object

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

comparer
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,T3,T4,T5>.other is not a Tuple<T1,T2,T3,T4,T5> object.

Exemplos

O exemplo a seguir cria uma matriz de objetos Tuple<T1,T2,T3,T4,T5> que contêm dados estatísticos de carreira para execução de backups no American Professional futebol.The following example creates an array of Tuple<T1,T2,T3,T4,T5> objects that contain career statistical data for running backs in American professional football. Os componentes da 5 tuplas consistem no nome do jogador, o número de jogos em que ele foi tocado, o número de contratações ou tentativas, o número total de jardas obtidas e o número de touchdowns pontuados.The 5-tuple's components consist of the player's name, the number of games in which he played, the number of carries or attempts, the total number of yards gained, and the number of touchdowns scored. O exemplo exibe os componentes de cada tupla na matriz em ordem não classificada, classifica a matriz e, em seguida, chama ToString para exibir cada tupla na ordem classificada.The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display each tuple in sorted order. Para classificar a matriz, o exemplo define uma classe de YardsGained genérica que implementa a interface IComparer e classifica os objetos Tuple<T1,T2,T3,T4,T5> em ordem decrescente pelo valor do quarto componente (jardas obtidas) em vez de pelo seu primeiro componente.To sort the array, the example defines a generic YardsGained class that implements the IComparer interface and sorts the Tuple<T1,T2,T3,T4,T5> objects in descending order by the value of their fourth component (yards gained) rather than by their first component. Observe que o exemplo não chama diretamente o método IStructuralComparable.CompareTo.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 YardsGained<T1, T2, T3, T4, T5> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2, T3, T4, T5> tX = x as Tuple<T1, T2, T3, T4, T5>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2, T3, T4, T5> tY = y as Tuple<T1, T2, T3, T4, T5>;
         return -1 * Comparer<T4>.Default.Compare(tX.Item4, tY.Item4);             
      }
   }
}

public class Example
{
   public static void Main()
   {
      // Organization of runningBacks 5-tuple:
      //    Component 1: Player name
      //    Component 2: Number of games played
      //    Component 3: Number of attempts (carries)
      //    Component 4: Number of yards gained 
      //    Component 5: Number of touchdowns   
      Tuple<string, int, int, int, int>[] runningBacks =
           { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
             Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
             Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
             Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
             Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) }; 

      // Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
      Console.WriteLine();
      
      // Sort the array
      Array.Sort(runningBacks, new YardsGained<string, int, int, int, int>());
      
      // Display the array in sorted order.
      Console.WriteLine("The values in sorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
   }
}
// The example displays the following output:
//       The values in unsorted order:
//       (Payton, Walter, 190, 3838, 16726, 110)
//       (Sanders, Barry, 153, 3062, 15269, 99)
//       (Brown, Jim, 118, 2359, 12312, 106)
//       (Dickerson, Eric, 144, 2996, 13259, 90)
//       (Faulk, Marshall, 176, 2836, 12279, 100)
//       
//       The values in sorted order:
//       (Brown, Jim, 118, 2359, 12312, 106)
//       (Dickerson, Eric, 144, 2996, 13259, 90)
//       (Faulk, Marshall, 176, 2836, 12279, 100)
//       (Payton, Walter, 190, 3838, 16726, 110)
//       (Sanders, Barry, 153, 3062, 15269, 99)
Imports System.Collections
Imports System.Collections.Generic

Public Class YardsGained(Of T1, T2, T3, T4, T5) : Implements IComparer
   Public Function Compare(x As Object, y As Object) As Integer _
                   Implements IComparer.Compare
      Dim tX As Tuple(Of T1, T2, T3, T4, T5) = TryCast(x, Tuple(Of T1, T2, T3, T4, T5))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY As Tuple(Of T1, T2, T3, T4, T5) = DirectCast(y, Tuple(Of T1, T2, T3, T4, T5))
         Return -1 * Comparer(Of T4).Default.Compare(tx.Item4, tY.Item4)             
      End If
   End Function
End Class

Module Example
   Public Sub Main()
      ' Organization of runningBacks 5-tuple:
      '    Component 1: Player name
      '    Component 2: Number of games played
      '    Component 3: Number of attempts (carries)
      '    Component 4: Number of yards gained 
      '    Component 5: Number of touchdowns   
      Dim runningBacks() =
          { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
            Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
            Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
            Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
            Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) } 

      ' Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:")
      For Each runningBack In runningBacks
         Console.WriteLine(runningBack.ToString())
      Next
      Console.WriteLine()
      
      ' Sort the array
      Array.Sort(runningBacks, New YardsGained(Of String, Integer, Integer, Integer, Integer)())
      
      ' Display the array in sorted order.
      Console.WriteLine("The values in sorted order:")
      For Each runningBack In runningBacks
         Console.WriteLine(runningBack.ToString())
      Next
   End Sub
End Module
' The example displays the following output:
'       The values in unsorted order:
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Faulk, Marshall, 176, 2836, 12279, 100)
'       
'       The values in sorted order:
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Faulk, Marshall, 176, 2836, 12279, 100)

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,T3,T4,T5> é convertida em uma interface de IStructuralComparable.It can be used only when the Tuple<T1,T2,T3,T4,T5> instance is cast to an IStructuralComparable interface.

Embora possa ser chamado diretamente, esse método é mais comumente chamado pelos métodos de classificação de coleção que incluem parâmetros IComparer para classificar 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 método IStructuralComparable.CompareTo destina-se ao 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 método IStructuralEquatable.Equals(Object, IEqualityComparer).To determine whether two objects are equal, call the IStructuralEquatable.Equals(Object, IEqualityComparer) method.

Aplica-se a