IComparable.CompareTo(Object) Metoda

Definice

Obor názvů:

System

Sestavení:

System.Runtime.dll

Porovná aktuální instanci s jiným objektem stejného typu a vrátí celé číslo, které určuje, zda aktuální instance předchází, následuje nebo se vyskytuje ve stejném pořadí řazení jako druhý objekt.

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

public int CompareTo (object? obj);

abstract member CompareTo : obj -> int

Public Function CompareTo (obj As Object) As Integer

Parametry

obj

Object

Objekt, který se má porovnat s touto instancí.

Návraty

Int32

Hodnota, která označuje relativní pořadí porovnávaných objektů. Vrácená hodnota má tyto významy:

Hodnota	Význam
Menší než nula	Tato instance předchází obj v pořadí řazení.
Nula	Tato instance se vyskytuje ve stejné pozici v pořadí řazení jako obj.
Větší než nula	Tato instance se řídí obj v pořadí řazení.

Výjimky

ArgumentException

obj není stejný typ jako tato instance.

Příklady

Následující příklad znázorňuje použití CompareTo k porovnání objektu Temperature, který implementuje IComparable s jiným objektem. Objekt Temperature implementuje CompareTo jednoduše zabalením volání Int32.CompareTo metody.

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

Poznámky

Metoda CompareTo je implementována podle typů, jejichž hodnoty lze řadit nebo řadit. Volá se automaticky metodami ne generických kolekcí objektů, jako je například Array.Sort, k seřazení každého člena pole. Pokud vlastní třída nebo struktura neimplementuje IComparable, jeho členy nelze uspořádat a operace řazení může vyvolat InvalidOperationException.

Tato metoda je pouze definice a musí být implementována konkrétní třídou nebo typem hodnoty, aby měla účinek. Význam porovnání zadaných v části Návratová hodnota ("předchází", "nastane ve stejné pozici jako" a "následující") závisí na konkrétní implementaci.

Podle definice se všechny objekty porovnávají nullvětší než (nebo následující) a dva odkazy s hodnotou null se vzájemně porovnávají.

Parametr, obj, musí být stejný typ jako třída nebo typ hodnoty, který implementuje toto rozhraní; v opačném případě je vyvolán ArgumentException.

Poznámky pro implementátory

U objektů A, B a C musí být splněné následující podmínky:

A.CompareTo(A) musí vrátit nulu.

Pokud A.CompareTo(B) vrátí nulu, B.CompareTo(A) musí vrátit nulu.

Pokud A.CompareTo(B) vrátí nulu a B.CompareTo(C) vrátí nulu, A.CompareTo(C) musí vrátit nulu.

Pokud A.CompareTo(B) vrátí jinou hodnotu než nula, B.CompareTo(A) musí vrátit hodnotu opačného znaménka.

Pokud A.CompareTo(B) vrátí hodnotu "x" nerovnající se nule a B.CompareTo(C) vrátí hodnotu "y" stejného znaménka jako "x", pak A.CompareTo(C) musí vrátit hodnotu stejného znaménka jako "x" a "y".

Poznámky pro volající

Pomocí metody CompareTo(Object) určete pořadí instancí třídy.

Viz také

• Object