IComparable.CompareTo(Object) Méthode

Référence

Définition

Espace de noms:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

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.

public:
 int CompareTo(System::Object ^ obj);

public int CompareTo (object obj);

public int CompareTo (object? obj);

abstract member CompareTo : obj -> int

Public Function CompareTo (obj As Object) As Integer

Paramètres

obj: Object

Objet à comparer à cette instance.

Retours

Int32

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

ArgumentException

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.

using namespace System;
using namespace System::Collections;

public ref class Temperature: public IComparable {
   /// <summary>
   /// IComparable.CompareTo implementation.
   /// </summary>
protected:
   // The value holder
   Double m_value;

public:
   virtual Int32 CompareTo( Object^ obj ) {
   
      if (obj == nullptr) return 1;
      
      if ( obj->GetType() == Temperature::typeid ) {
         Temperature^ temp = dynamic_cast<Temperature^>(obj);

         return m_value.CompareTo( temp->m_value );
      }
      throw gcnew ArgumentException(  "object is not a Temperature" );
   }

   property Double Value {
      Double get() {
         return m_value;
      }
      void set( Double value ) {
         m_value = value;
      }
   }

   property Double Celsius  {
      Double get() {
         return (m_value - 32) / 1.8;
      }
      void set( Double value ) {
         m_value = (value * 1.8) + 32;
      }
   }
};

int main()
{
   ArrayList^ temperatures = gcnew ArrayList;
   // Initialize random number generator.
   Random^ rnd = gcnew Random;

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

   // Sort ArrayList.
   temperatures->Sort();
      
   for each (Temperature^ temp in temperatures)
      Console::WriteLine(temp->Value);
   return 0;
}
// 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

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

open System
open System.Collections

type Temperature() =
    // The temperature value
    let mutable temperatureF = 0.

    interface IComparable with
        member _.CompareTo(obj) =
            match obj with 
            | null -> 1
            | :? Temperature as other -> 
                temperatureF.CompareTo other.Fahrenheit
            | _ ->
                invalidArg (nameof obj) "Object is not a Temperature"

    member _.Fahrenheit 
        with get () =
            temperatureF
        and set (value) = 
            temperatureF <- value

    member _.Celsius
        with get () =
            (temperatureF - 32.) * (5. / 9.)
        and set (value) =
            temperatureF <- (value * 9. / 5.) + 32.

let temperatures = ResizeArray()

// Initialize random number generator.
let rnd = Random()

// Generate 10 temperatures between 0 and 100 randomly.
for _ = 1 to 10 do
    let degrees = rnd.Next(0, 100)
    let temp = Temperature(Fahrenheit=degrees)
    temperatures.Add temp

// Sort ResizeArray.
temperatures.Sort()

for temp in temperatures do
    printfn $"{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

Imports System.Collections

Public Class Temperature
    Implements IComparable
    ' The temperature value
    Protected temperatureF As Double

    Public Overloads Function CompareTo(ByVal obj As Object) As Integer _
        Implements IComparable.CompareTo
        
        If obj Is Nothing Then Return 1

        Dim otherTemperature As Temperature = TryCast(obj, Temperature)
        If otherTemperature IsNot Nothing Then
            Return Me.temperatureF.CompareTo(otherTemperature.temperatureF)
        Else
           Throw New ArgumentException("Object is not a Temperature")
        End If   
    End Function

    Public Property Fahrenheit() As Double
        Get
            Return temperatureF
        End Get
        Set(ByVal Value As Double)
            Me.temperatureF = Value
        End Set
    End Property

    Public Property Celsius() As Double
        Get
            Return (temperatureF - 32) * (5/9)
        End Get
        Set(ByVal Value As Double)
            Me.temperatureF = (Value * 9/5) + 32
        End Set
    End Property
End Class

Public Module CompareTemperatures
   Public Sub Main()
      Dim temperatures As New ArrayList
      ' Initialize random number generator.
      Dim rnd As New Random()
      
      ' Generate 10 temperatures between 0 and 100 randomly.
      For ctr As Integer = 1 To 10
         Dim degrees As Integer = rnd.Next(0, 100)
         Dim temp As New Temperature
         temp.Fahrenheit = degrees
         temperatures.Add(temp)   
      Next

      ' Sort ArrayList.
      temperatures.Sort()
      
      For Each temp As Temperature In temperatures
         Console.WriteLine(temp.Fahrenheit)
      Next      
   End Sub
End Module
' 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 à

Voir aussi

Object

Partager via