Lire en anglais

Partager via


IComparable.CompareTo(Object) Méthode

Définition

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

C#
public int CompareTo (object obj);
C#
public int CompareTo (object? obj);

Paramètres

obj
Object

Objet à comparer à cette instance.

Retours

Valeur qui indique l’ordre relatif des objets comparés. La valeur de retour a ces significations :

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

Exceptions

obj n’est pas le même type que cette instance.

Exemples

L’exemple suivant illustre l’utilisation de CompareTo pour comparer un objet Temperature implémentant IComparable avec un autre objet. L’objet Temperature implémente CompareTo en encapsulant simplement un appel à la méthode Int32.CompareTo.

C#
using System;
using System.Collections;

public class Temperature : IComparable
{
    // The temperature value
    protected double temperatureF;

    public int CompareTo(object obj) {
        if (obj == null) return 1;

        Temperature otherTemperature = obj as Temperature;
        if (otherTemperature != null)
            return this.temperatureF.CompareTo(otherTemperature.temperatureF);
        else
           throw new ArgumentException("Object is not a Temperature");
    }

    public double Fahrenheit
    {
        get
        {
            return this.temperatureF;
        }
        set 
        {
            this.temperatureF = value;
        }
    }

    public double Celsius
    {
        get
        {
            return (this.temperatureF - 32) * (5.0/9);
        }
        set
        {
            this.temperatureF = (value * 9.0/5) + 32;
        }
    }
}

public class CompareTemperatures
{
   public static void Main()
   {
      ArrayList temperatures = new ArrayList();
      // Initialize random number generator.
      Random rnd = new Random();

      // Generate 10 temperatures between 0 and 100 randomly.
      for (int ctr = 1; ctr <= 10; ctr++)
      {
         int degrees = rnd.Next(0, 100);
         Temperature temp = new Temperature();
         temp.Fahrenheit = degrees;
         temperatures.Add(temp);
      }

      // Sort ArrayList.
      temperatures.Sort();

      foreach (Temperature temp in temperatures)
         Console.WriteLine(temp.Fahrenheit);
   }
}
// The example displays the following output to the console (individual
// values may vary because they are randomly generated):
//       2
//       7
//       16
//       17
//       31
//       37
//       58
//       66
//       72
//       95

Remarques

La méthode CompareTo est implémentée par des types dont les valeurs peuvent être triées ou triées. Il est appelé automatiquement par des méthodes d’objets de collection non génériques, tels que Array.Sort, pour classer chaque membre du tableau. Si une classe ou une structure personnalisée n’implémente pas IComparable, ses membres ne peuvent pas être ordonnés et l’opération de tri peut lever une InvalidOperationException.

Cette méthode n’est qu’une définition et doit être implémentée par un type de classe ou de valeur spécifique pour avoir effet. La signification des comparaisons spécifiées dans la section Valeur de retour (« 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 plus (ou suit) null, et deux références null sont comparées les unes aux autres.

Le paramètre, obj, doit être le même type que le type classe ou valeur qui implémente cette interface ; sinon, une ArgumentException est levée.

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) doit retourner zéro.

Si A.CompareTo(B) retourne zéro, B.CompareTo(A) doit retourner zéro.

Si A.CompareTo(B) retourne zéro et B.CompareTo(C) retourne zéro, A.CompareTo(C) doit retourner zéro.

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

Si A.CompareTo(B) retourne une valeur « x » non égale à zéro, et B.CompareTo(C) retourne une valeur « y » du même signe que « x », alors A.CompareTo(C) devez retourner une valeur du même signe que « x » et « y ».

Notes pour les appelants

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

S’applique à

Produit Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Voir aussi