IComparable.CompareTo(Object) 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(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 les significations suivantes :

Valeur Signification
Inférieure à 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érieure à zéro Cette instance suit obj dans l'ordre de tri.

Exceptions

obj n'est pas du même type que cette instance.

Exemples

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

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
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 CompareTo méthode est implémentée par les types dont les valeurs peuvent être triées ou triées. Elle est appelée automatiquement par les méthodes des 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 triés et l’opération de tri peut lever une InvalidOperationException .

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

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

Le paramètre, obj , doit être du même type que la classe ou le type valeur qui implémente cette interface ; sinon, une ArgumentException exception 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 : Un. CompareTo (A) doit retourner zéro.

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

Si un. CompareTo (B) retourne zéro et B. CompareTo (c) retourne zéro, alors . CompareTo (c) doit retourner zéro.

Si un. CompareTo (B) retourne une valeur différente de zéro, B. CompareTo (A) doit retourner une valeur du signe opposé.

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

Notes pour les appelants

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

S’applique à

Voir aussi