IComparable.CompareTo(Object) IComparable.CompareTo(Object) IComparable.CompareTo(Object) IComparable.CompareTo(Object) Method

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.Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public:
 int CompareTo(System::Object ^ obj);
public int CompareTo (object obj);
abstract member CompareTo : obj -> int
Public Function CompareTo (obj As Object) As Integer

Paramètres

obj
Object Object Object Object

Objet à comparer à cette instance.An object to compare with this instance.

Retours

Valeur qui indique l'ordre relatif des objets comparés.A value that indicates the relative order of the objects being compared. La valeur de retour a les significations suivantes :The return value has these meanings:

ValueValue SignificationMeaning
Inférieure à zéroLess than zero Cette instance précède obj dans l'ordre de tri.This instance precedes obj in the sort order.

ZéroZero Cette instance se produit à la même position dans l'ordre de tri que obj.This instance occurs in the same position in the sort order as obj.

Supérieure à zéroGreater than zero Cette instance suit obj dans l'ordre de tri.This instance follows obj in the sort order.

Exceptions

obj n'est pas du même type que cette instance.obj is not the same type as this instance.

Exemples

L’exemple suivant illustre l’utilisation de CompareTo pour comparer un Temperature objet qui implémente IComparable avec un autre objet.The following example illustrates the use of CompareTo to compare a Temperature object implementing IComparable with another object. L' Temperature objet Int32.CompareTo implémente en encapsulant simplement un appel à la méthode. CompareToThe Temperature object implements CompareTo by simply wrapping a call to the Int32.CompareTo method.

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.The CompareTo method is implemented by types whose values can be ordered or sorted. Elle est appelée automatiquement par les méthodes des objets de collection non génériques, tels Array.Sortque, pour classer chaque membre du tableau.It is called automatically by methods of non-generic collection objects, such as Array.Sort, to order each member of the array. Si une classe ou une structure personnalisée n’implémente IComparablepas, ses membres ne peuvent pas être triés et l’opération de tri peut lever une. InvalidOperationExceptionIf a custom class or structure does not implement IComparable, its members cannot be ordered and the sort operation can throw an 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.This method is only a definition and must be implemented by a specific class or value type to have effect. 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.The meaning of the comparisons specified in the Return Value section ("precedes", "occurs in the same position as", and "follows") depends on the particular implementation.

Par définition, tout objet compare supérieur à (ou suit) nullet deux références null sont égales les unes aux autres.By definition, any object compares greater than (or follows) null, and two null references compare equal to each other.

Le paramètre, obj, doit être du même type que la classe ou le type valeur qui implémente cette interface; sinon, ArgumentException une exception est levée.The parameter, obj, must be the same type as the class or value type that implements this interface; otherwise, an ArgumentException is thrown.

Notes pour les responsables de l’implémentation

Pour les objets A, B et C, les éléments suivants doivent être vrais:For objects A, B and C, the following must be true: Un. CompareTo (A) doit retourner zéro.A.CompareTo(A) must return zero.

Si un. CompareTo (B) retourne la valeur zéro, B. CompareTo (A) doit retourner zéro.If A.CompareTo(B) returns zero, then B.CompareTo(A) must return zero.

Si un. CompareTo (B) retourne zéro et B. CompareTo (c) retourne zéro, alors . CompareTo (c) doit retourner zéro.If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero, then A.CompareTo(C) must return zero.

Si un. CompareTo (B) retourne une valeur différente de zéro, B. CompareTo (A) doit retourner une valeur du signe opposé.If A.CompareTo(B) returns a value other than zero, then B.CompareTo(A) must return a value of the opposite sign.

Si un. CompareTo (B) retourne une valeur x qui n’est pas égale à zéro et B. CompareTo (c) retourne y une valeur du même signe xque, alors . CompareTo (c) doit retourner une valeur du même signe que x et y.If A.CompareTo(B) returns a value x not equal to zero, and B.CompareTo(C) returns a value y of the same sign as x, then A.CompareTo(C) must return a value of the same sign as x and y.

Notes pour les appelants

Utilisez la CompareTo(Object) méthode pour déterminer l’ordre des instances d’une classe.Use the CompareTo(Object) method to determine the ordering of instances of a class.

S’applique à

Voir aussi