IComparable.CompareTo(Object) Método

Definición

Compara la instancia actual con otro objeto del mismo tipo y devuelve un entero que indica si la posición de la instancia actual es anterior, posterior o igual que la del otro objeto en el criterio de ordenación.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

Parámetros

obj
Object

Objeto que se va a comparar con esta instancia.An object to compare with this instance.

Devoluciones

Un valor que indica el orden relativo de los objetos que se están comparando.A value that indicates the relative order of the objects being compared. El valor devuelto tiene los siguientes significados:The return value has these meanings:

ValorValue SignificadoMeaning
Menor que ceroLess than zero Esta instancia es anterior a obj en el criterio de ordenación.This instance precedes obj in the sort order.
CeroZero Esta instancia se produce en la misma posición del criterio de ordenación que obj.This instance occurs in the same position in the sort order as obj.
Mayor que ceroGreater than zero Esta instancia sigue a obj en el criterio de ordenación.This instance follows obj in the sort order.

Excepciones

obj no es del mismo tipo que esta instancia.obj is not the same type as this instance.

Ejemplos

En el ejemplo siguiente se muestra el uso CompareTo de para comparar Temperature un objeto IComparable que implementa con otro objeto.The following example illustrates the use of CompareTo to compare a Temperature object implementing IComparable with another object. El Temperature objeto CompareTo implementa simplementeInt32.CompareTo encapsulando una llamada al método.The 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

Comentarios

El CompareTo método se implementa mediante tipos cuyos valores se pueden ordenar o ordenar.The CompareTo method is implemented by types whose values can be ordered or sorted. Se llama automáticamente a los métodos de objetos de colección no genéricos, como Array.Sort, para ordenar cada miembro de la matriz.It is called automatically by methods of non-generic collection objects, such as Array.Sort, to order each member of the array. Si una clase o estructura personalizada no implementa IComparable, sus miembros no se pueden ordenar y la operación de ordenación puede producir una excepción. InvalidOperationExceptionIf a custom class or structure does not implement IComparable, its members cannot be ordered and the sort operation can throw an InvalidOperationException.

Este método es solo una definición y debe implementarse mediante un tipo de valor o una clase específica para que surta efecto.This method is only a definition and must be implemented by a specific class or value type to have effect. El significado de las comparaciones especificadas en la sección valor devuelto ("precede a", "se produce en la misma posición que" y "sigue") depende de la implementación concreta.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.

Por definición, cualquier objeto compara mayor que (o sigue) nully dos referencias nulas se comparan igual entre sí.By definition, any object compares greater than (or follows) null, and two null references compare equal to each other.

El parámetro, obj, debe ser del mismo tipo que la clase o el tipo de valor que implementa esta interfaz; de lo ArgumentException contrario, se produce una excepción.The parameter, obj, must be the same type as the class or value type that implements this interface; otherwise, an ArgumentException is thrown.

Notas a los implementadores

En el caso de los objetos A, B y C, debe cumplirse lo siguiente:For objects A, B and C, the following must be true: A. CompareTo (A) debe devolver cero.A.CompareTo(A) must return zero.

Si a. CompareTo (B) devuelve cero, B. CompareTo (a) debe devolver cero.If A.CompareTo(B) returns zero, then B.CompareTo(A) must return zero.

Si a. CompareTo (B) devuelve cero y B. CompareTo (c) devuelve cero y, a continuación, a . CompareTo (c) debe devolver cero.If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero, then A.CompareTo(C) must return zero.

Si a. CompareTo (B) devuelve un valor distinto de cero, B. CompareTo (a) debe devolver un valor del signo opuesto.If A.CompareTo(B) returns a value other than zero, then B.CompareTo(A) must return a value of the opposite sign.

Si . CompareTo (B) devuelve un valor x distinto de cero y B. CompareTo (c) y devuelve un valor del mismo signo xque, a . CompareTo (c) debe devolver un valor del mismo signo que x y 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.

Notas a los autores de las llamadas

Utilice el CompareTo(Object) método para determinar el orden de las instancias de una clase.Use the CompareTo(Object) method to determine the ordering of instances of a class.

Se aplica a

Consulte también: