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

Definición

Compara el objeto Tuple<T1,T2> actual con un objeto especificado utilizando un comparador especificado y devuelve un entero que indica si el objeto actual precede o sigue al objeto especificado, o si se encuentra en la misma posición que dicho objeto en el criterio de ordenación.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

Objeto que se va a comparar con la instancia actual.An object to compare with the current instance.

comparer
IComparer IComparer IComparer

Un objeto que proporciona reglas personalizadas para la comparación.An object that provides custom rules for comparison.

Devoluciones

Entero con signo que indica la posición relativa de esta instancia y other en el criterio de ordenación, tal como se muestra en la tabla siguiente.A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

ValorValue DescripciónDescription
Un entero negativoA negative integer Esta instancia precede a other.This instance precedes other.
CeroZero En el criterio de ordenación, esta instancia y other tienen la misma posición.This instance and other have the same position in the sort order.
Un entero positivo.A positive integer Esta instancia es posterior a other.This instance follows other.

Implementaciones

Excepciones

other no es un objeto Tuple<T1,T2>.other is not a Tuple<T1,T2> object.

Ejemplos

En el ejemplo siguiente se crea una Tuple<T1,T2> matriz de objetos formada por el nombre de un estudiante y la puntuación de la prueba.The following example creates an array of Tuple<T1,T2> objects that consist of a student's name and test score. Muestra el componente de cada tupla en la matriz en orden sin ordenar, ordena la matriz y, a continuación, llama ToString a para mostrar el valor de cada tupla en orden.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 ordenar la matriz, en el ejemplo se define ScoreComparer una clase genérica que implementa IComparer la interfaz y ordena Tuple<T1,T2> los objetos en orden ascendente por el valor de su segundo componente en lugar de su primer 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. Tenga en cuenta que el ejemplo no llama directamente IStructuralComparable.CompareTo al método.Note that the example does not directly call the IStructuralComparable.CompareTo method. El Array.Sort(Array, IComparer) método llama implícitamente a este método para cada elemento de la 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)

Comentarios

Este miembro es una implementación explícita de un miembro de interfaz.This member is an explicit interface member implementation. Solo se puede utilizar cuando la instancia de Tuple<T1,T2> se convierte en una interfaz IStructuralComparable.It can be used only when the Tuple<T1,T2> instance is cast to an IStructuralComparable interface.

Aunque se puede llamar a este método directamente, se suele llamar mediante métodos de ordenación de colección que IComparer incluyen parámetros para ordenar los miembros de una colección.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 ejemplo, Array.Sort(Array, IComparer) se llama mediante el método y el Add método de un SortedList objeto del que se crea una instancia mediante el SortedList.SortedList(IComparer) constructor.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.

Precaución

El IStructuralComparable.CompareTo método está pensado para su uso en operaciones de ordenación.The IStructuralComparable.CompareTo method is intended for use in sorting operations. No debe usarse cuando el propósito principal de una comparación es determinar si dos objetos son iguales.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Para determinar si dos objetos son iguales, llame al IStructuralEquatable.Equals método.To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

Se aplica a

Consulte también: