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

Définition

Compare l'objet Tuple<T1> actif à un objet spécifié à l'aide d'un comparateur spécifié et retourne un entier qui indique si l'objet actif précède, suit ou est dans la même position que l'objet spécifié dans l'ordre de tri.Compares the current Tuple<T1> 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

Paramètres

other
Object Object Object

Objet à comparer à l'instance actuelle.An object to compare with the current instance.

comparer
IComparer IComparer IComparer

Un objet qui fournit des règles personnalisées pour la comparaison.An object that provides custom rules for comparison.

Retours

Entier signé qui indique la position relative de cette instance et de other dans l’ordre de tri, comme indiqué dans le tableau suivant.A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

ValueValue Description Description
Entier négatifA negative integer Cette instance précède other.This instance precedes other.
ZéroZero Cette instance et other ont la même position dans l'ordre de tri.This instance and other have the same position in the sort order.
Entier positifA positive integer Cette instance suit other.This instance follows other.

Implémente

Exceptions

other n’est pas un objet Tuple<T1>.other is not a Tuple<T1> object.

Exemples

L’exemple suivant définit une classe générique nommée DescendingComparer qui implémente le IComparer<T> interface.The following example defines a generic class named DescendingComparer that implements the IComparer<T> interface. DescendingComparer Trie les objets dans l’ordre décroissant plutôt que par ordre croissant en inversant la valeur retournée par le comparateur par défaut pour un type particulier.DescendingComparer sorts objects in descending rather than ascending order by reversing the value returned by the default comparer for a particular type. Une instance du générique DescendingComparer classe est ensuite transmise à la Array.Sort(Array, IComparer) méthode pour trier un tableau de Tuple<T1> objets dans l’ordre décroissant.An instance of the generic DescendingComparer class is then passed to the Array.Sort(Array, IComparer) method to sort an array of Tuple<T1> objects in descending order. Notez que l’exemple n’appelle pas directement la IStructuralComparable.CompareTo (méthode).Note that the example does not directly call the IStructuralComparable.CompareTo method. Cette méthode est appelée implicitement par la Array.Sort(Array, IComparer) méthode pour chaque élément du tableau.This method is called implicitly by the Array.Sort(Array, IComparer) method for each element in the array.

using System;
using System.Collections.Generic;

public class DescendingComparer<T> : IComparer<T>
{
    public int Compare(T x, T y) 
    {
        return -1 * Comparer<T>.Default.Compare(x, y);
    }
}

class CompareTo2
{
   static void Main()
   {
       Tuple<Double>[] values = { Tuple.Create(13.54),
                                  Tuple.Create(Double.NaN),
                                  Tuple.Create(-189.42993),
                                  Tuple.Create(Double.PositiveInfinity),
                                  Tuple.Create(Double.Epsilon),
                                  Tuple.Create(1.934E-17),
                                  Tuple.Create(Double.NegativeInfinity),
                                  Tuple.Create(-0.000000000003588),
                                  null };
       Console.WriteLine("The values in unsorted order:");
       foreach (var value in values)
           if (value != null)
               Console.WriteLine("   {0}", value.Item1);
           else
               Console.WriteLine("   <null>");
       Console.WriteLine();

       Array.Sort(values, new DescendingComparer<Tuple<Double>>());

       Console.WriteLine("The values sorted in descending order:");
       foreach (var value in values)
           if (value != null)
               Console.WriteLine("   {0}", value.Item1);
           else
               Console.WriteLine("   <null>");
    }
}
// The example displays the following output:
//      The values in unsorted order:
//         13.54
//         NaN
//         -189.42993
//         Infinity
//         4.94065645841247E-324
//         1.934E-17
//         -Infinity
//         -3.588E-12
//
//      The values sorted in descending order:
//         Infinity
//         13.54
//         1.934E-17
//         4.94065645841247E-324
//         -3.588E-12
//         -189.42993
//         -Infinity
//         NaN
Imports System.Collections.Generic

Public Class DescendingComparer(Of T) : Implements IComparer(Of T)
    Public Function Compare(ByVal x As T, ByVal y As T) As Integer Implements IComparer(Of T).Compare
        Return -1 * Comparer(Of T).Default.Compare(x, y)
    End Function
End Class

Module Example
    Sub Main()
        Dim values() = { Tuple.Create(13.54),
                         Tuple.Create(Double.NaN),
                         Tuple.Create(-189.42993),
                         Tuple.Create(Double.PositiveInfinity),
                         Tuple.Create(Double.Epsilon),
                         Tuple.Create(1.934E-17),
                         Tuple.Create(Double.NegativeInfinity),
                         Tuple.Create(-0.000000000003588),
                         Nothing}

        Console.WriteLine("The values in unsorted order:")
        For Each value As Tuple(Of Double) In values
            If value IsNot Nothing Then
                Console.WriteLine("   {0}", value.Item1)
            Else
                Console.WriteLine("   <null>")
            End If
        Next
        Console.WriteLine()

        Array.Sort(values, New DescendingComparer(Of Tuple(Of Double)))

        Console.WriteLine("The values sorted in descending order:")
        For Each value As Tuple(Of Double) In values
            If value IsNot Nothing Then
                Console.WriteLine("   {0}", value.Item1)
            Else
                Console.WriteLine("   <null>")
            End If
        Next
    End Sub
End Module
' The example displays the following output:
'      The values in unsorted order:
'         13.54
'         NaN
'         -189.42993
'         Infinity
'         4.94065645841247E-324
'         1.934E-17
'         -Infinity
'         -3.588E-12
'
'      The values sorted in descending order:
'         Infinity
'         13.54
'         1.934E-17
'         4.94065645841247E-324
'         -3.588E-12
'         -189.42993
'         -Infinity
'         NaN

Remarques

Bien que cette méthode peut être appelée directement, elle est généralement appelée par les méthodes qui incluent de tri de collection IComparer paramètres pour classer les membres d’une collection.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. Par exemple, elle est appelée par le Array.Sort(Array, IComparer) (méthode) et le Add méthode d’un SortedList objet est instancié à l’aide de la SortedList.SortedList(IComparer) constructeur.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.

Attention

Le IStructuralComparable.CompareTo méthode est conçue pour une utilisation dans les opérations de tri.The IStructuralComparable.CompareTo method is intended for use in sorting operations. Elle ne doit pas être utilisée lors de l’objectif principal d’une comparaison consiste à déterminer si deux objets sont égaux.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Pour déterminer si deux objets sont égales, appelez le IStructuralEquatable.Equals (méthode).To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

S’applique à

Voir aussi