IComparable.CompareTo(Object) Methode

Definition

Vergleicht die aktuelle Instanz mit einem anderen Objekt vom selben Typ und gibt eine ganze Zahl zurück, die angibt, ob die aktuelle Instanz in der Sortierreihenfolge vor oder nach dem anderen Objekt oder an derselben Position auftritt.

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

Parameter

obj
Object

Ein Objekt, das mit dieser Instanz verglichen werden soll.

Gibt zurück

Int32

Ein Wert, der die relative Reihenfolge der verglichenen Objekte angibt. Der Rückgabewert hat folgende Bedeutung:

Wert Bedeutung
Kleiner als 0 (null) Diese Instanz befindet sich in der Sortierreihenfolge vor obj.
Zero Diese Instanz tritt in der Sortierreihenfolge an der gleichen Position wie obj auf.
Größer als 0 (null) Diese Instanz folgt in der Sortierreihenfolge auf obj.

Ausnahmen

obj hat nicht denselben Typ wie diese Instanz.

Beispiele

Das folgende Beispiel veranschaulicht die Verwendung von CompareTo zum Vergleichen eines Temperature -Objekts, das IComparable implementiert, mit einem anderen -Objekt. Das Temperature -Objekt CompareTo implementiert, indem einfach ein Aufruf der -Methode umbrochen Int32.CompareTo wird.

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

Hinweise

Die CompareTo -Methode wird von Typen implementiert, deren Werte sortiert oder sortiert werden können. Sie wird automatisch von Methoden von nicht generischen Auflistungsobjekten wie aufgerufen, Array.Sort um jeden Member des Arrays zu ordnen. Wenn eine benutzerdefinierte Klasse oder Struktur nicht IComparable implementiert, können ihre Member nicht sortiert werden, und der Sortiervorgang kann eine InvalidOperationException auslösen.

Diese Methode ist nur eine Definition und muss von einer bestimmten Klasse oder einem bestimmten Werttyp implementiert werden, damit sie wirksam wird. Die Bedeutung der im Abschnitt Rückgabewert angegebenen Vergleiche ("precedes", "occurs in the same position as" und "follows") hängt von der jeweiligen Implementierung ab.

Definitionsgemäß vergleicht jedes Objekt größer als (oder folgt), null und zwei NULL-Verweise sind gleich.

Der -Parameter obj muss dem Typ der Klasse oder dem Werttyp entsprechen, der diese Schnittstelle implementiert. Andernfalls wird eine ArgumentException ausgelöst.

Hinweise für Ausführende

Für die Objekte A, B und C muss Folgendes zutreffen: A.CompareTo(A) muss 0 (null) zurückgeben.

Wenn A.CompareTo(B) 0 (null) zurückgibt, muss B.CompareTo(A) 0 zurückgeben.

Wenn A.CompareTo(B) 0 (null) und B.CompareTo(C) 0 (null) zurückgibt, muss A.CompareTo(C) null zurückgeben.

Wenn A.CompareTo(B) einen anderen Wert als 0 (null) zurückgibt, muss B.CompareTo(A) einen Wert des entgegengesetzten Vorzeichens zurückgeben.

Wenn A.CompareTo(B) einen Wert zurückgibt, der x ungleich 0 (null) ist, und B.CompareTo(C) einen Wert y desselben Vorzeichens wie zurückgibt, x muss A.CompareTo(C) einen Wert desselben Vorzeichens wie x und y zurückgeben.

Hinweise für Aufrufer

Verwenden Sie die CompareTo(Object) -Methode, um die Reihenfolge von Instanzen einer Klasse zu bestimmen.

Gilt für

Siehe auch