Lire en anglais

Partager via


IComparable<T>.CompareTo(T) Méthode

Définition

Compare l'instance actuelle avec un autre objet du même type et retourne un entier qui indique si l'instance actuelle précède ou suit un autre objet ou se trouve à la même position dans l'ordre de tri.

public int CompareTo (T other);
public int CompareTo (T? other);

Paramètres

other
T

Objet à comparer à cette instance.

Retours

Int32

Valeur qui indique l'ordre relatif des objets comparés. La valeur de retour a les significations suivantes :

Valeur Signification
Inférieure à zéro Cette instance précède other dans l'ordre de tri.
Zéro Cette instance se produit à la même position dans l'ordre de tri que other.
Supérieure à zéro Cette instance suit other dans l'ordre de tri.

Exemples

L’exemple de code suivant illustre l’implémentation d’un IComparable<T> objet simple Temperature . L’exemple crée une SortedList<TKey,TValue> collection de chaînes avec Temperature des clés d’objet et ajoute plusieurs paires de températures et de chaînes à la liste hors séquence. Dans l’appel à la Add méthode, la SortedList<TKey,TValue> collection utilise l’implémentation IComparable<T> pour trier les entrées de liste, qui sont ensuite affichées dans l’ordre d’augmentation de la température.

using System;
using System.Collections.Generic;

public class Temperature : IComparable<Temperature>
{
    // Implement the generic CompareTo method with the Temperature
    // class as the Type parameter.
    //
    public int CompareTo(Temperature other)
    {
        // If other is not a valid object reference, this instance is greater.
        if (other == null) return 1;

        // The temperature comparison depends on the comparison of
        // the underlying Double values.
        return m_value.CompareTo(other.m_value);
    }

    // Define the is greater than operator.
    public static bool operator >  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) > 0;
    }

    // Define the is less than operator.
    public static bool operator <  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) < 0;
    }

    // Define the is greater than or equal to operator.
    public static bool operator >=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) >= 0;
    }

    // Define the is less than or equal to operator.
    public static bool operator <=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) <= 0;
    }

    // The underlying temperature value.
    protected double m_value = 0.0;

    public double Celsius
    {
        get
        {
            return m_value - 273.15;
        }
    }

    public double Kelvin
    {
        get
        {
            return m_value;
        }
        set
        {
            if (value < 0.0)
            {
                throw new ArgumentException("Temperature cannot be less than absolute zero.");
            }
            else
            {
                m_value = value;
            }
        }
    }

    public Temperature(double kelvins)
    {
        this.Kelvin = kelvins;
    }
}

public class Example
{
    public static void Main()
    {
        SortedList<Temperature, string> temps =
            new SortedList<Temperature, string>();

        // Add entries to the sorted list, out of order.
        temps.Add(new Temperature(2017.15), "Boiling point of Lead");
        temps.Add(new Temperature(0), "Absolute zero");
        temps.Add(new Temperature(273.15), "Freezing point of water");
        temps.Add(new Temperature(5100.15), "Boiling point of Carbon");
        temps.Add(new Temperature(373.15), "Boiling point of water");
        temps.Add(new Temperature(600.65), "Melting point of Lead");

        foreach( KeyValuePair<Temperature, string> kvp in temps )
        {
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value, kvp.Key.Celsius);
        }
    }
}
/* This example displays the following output:
      Absolute zero is -273.15 degrees Celsius.
      Freezing point of water is 0 degrees Celsius.
      Boiling point of water is 100 degrees Celsius.
      Melting point of Lead is 327.5 degrees Celsius.
      Boiling point of Lead is 1744 degrees Celsius.
      Boiling point of Carbon is 4827 degrees Celsius.
*/

Remarques

CompareTo fournit une méthode de comparaison fortement typée pour classer les membres d’un objet de collection générique. En raison de cela, il n’est généralement pas appelé directement à partir du code du développeur. Au lieu de cela, elle est appelée automatiquement par des méthodes telles que List<T>.Sort() et Add.

Cette méthode n’est qu’une définition et doit être implémentée par un type de classe ou valeur spécifique pour avoir effet. La signification des comparaisons spécifiées dans la section Valeurs renvoyées (« précède », « se produit dans la même position que » et « suit ») dépend de l’implémentation particulière.

Par définition, tout objet compare supérieur nullà , et deux références Null sont égales les unes aux autres.

Notes pour les responsables de l’implémentation

Pour les objets A, B et C, les éléments suivants doivent être vrais : A.CompareTo(A) est nécessaire pour retourner zéro.

Si A.CompareTo(B) retourne zéro, B.CompareTo(A) est requis pour retourner zéro.

Si A.CompareTo(B) retourne zéro et B.CompareTo(C) retourne zéro, A.CompareTo(C) est nécessaire pour retourner zéro.

Si A.CompareTo(B) retourne une valeur autre que zéro, B.CompareTo(A) est nécessaire pour retourner une valeur du signe opposé.

Si A.CompareTo(B) retourne une valeur x qui n’est pas égale à zéro, et B.CompareTo(C) retourne une valeur y du même signe que x, alors A.CompareTo(C) est nécessaire pour retourner une valeur du même signe que x et y.

Notes pour les appelants

Utilisez la CompareTo(T) méthode pour déterminer l’ordre des instances d’une classe.

S’applique à

Voir aussi