IComparable.CompareTo(Object) Método

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

Parâmetros

Devoluções

Um valor que indica a ordem relativa dos objetos a comparar. O valor de retorno tem os seguintes significados:

Exceções

Exemplos

O exemplo seguinte ilustra a utilização de CompareTo para comparar um Temperature objeto implementado IComparable com outro objeto. O Temperature objeto implementa CompareTo simplesmente ao envolver uma chamada no Int32.CompareTo método.

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

Observações

O CompareTo método é implementado por tipos cujos valores podem ser ordenados ou ordenados. É chamada automaticamente por métodos de objetos de coleção não genéricos, como Array.Sort, para ordenar cada membro do array. Se uma classe ou estrutura personalizada não implementar IComparable, os seus membros não podem ser ordenados e a operação de ordenação pode gerar um InvalidOperationException.

Este método é apenas uma definição e deve ser implementado por uma classe ou tipo de valor específico para ter efeito. O significado das comparações especificadas na secção de Valor de Retorno ("precede", "ocorre na mesma posição que" e "segue") depende da implementação em particular.

Por definição, qualquer objeto compara-se maior que (ou segue) null, e duas referências nulas comparam-se iguais entre si.

O parâmetro, obj, deve ser do mesmo tipo da classe ou do tipo de valor que implementa esta interface; caso contrário, um ArgumentException é lançado.

Notas para Implementadores

Para os objetos A, B e C, o seguinte deve ser verdadeiro:

A.CompareTo(A) deve devolver zero.

Se A.CompareTo(B) devolver zero, então B.CompareTo(A) deve devolver zero.

Se A.CompareTo(B) devolver zero e B.CompareTo(C) devolver zero, então A.CompareTo(C) deve devolver zero.

Se A.CompareTo(B) devolver um valor diferente de zero, então B.CompareTo(A) deve devolver um valor do signo oposto.

Se A.CompareTo(B) devolver um valor "x" não igual a zero, e B.CompareTo(C) devolver um valor "y" do mesmo sinal que "x", então A.CompareTo(C) deve devolver um valor do mesmo sinal que "x" e "y".

Notas para Chamadores

Use o CompareTo(Object) método para determinar a ordem das instâncias de uma classe.

Ver também

• Object