IComparable.CompareTo(Object) Methode

Referenz

Definition

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Vergleicht die aktuelle Instanz mit einem anderen Objekt desselben Typs und gibt eine ganze Zahl zurück, die angibt, ob die aktuelle Instanz vorgeht, folgt oder in derselben Position in der Sortierreihenfolge wie das andere Objekt 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 zu vergleichenden Objekte angibt. Der Rückgabewert hat die folgenden Bedeutungen:

Wert	Bedeutung
Kleiner als Null	Diese Instanz steht vor `obj` in der Sortierreihenfolge.
Null	Diese Instanz tritt an der gleichen Position in der Sortierreihenfolge wie `obj`auf.
Größer als Null	Diese Instanz folgt `obj` in der Sortierreihenfolge.

Ausnahmen

ArgumentException

obj ist nicht derselbe Typ wie diese Instanz.

Beispiele

Im folgenden Beispiel wird die Verwendung von CompareTo veranschaulicht, um ein Temperature Objekt zu vergleichen, das IComparable mit einem anderen Objekt implementiert. Das Temperature-Objekt implementiert CompareTo, indem einfach ein Aufruf der Int32.CompareTo-Methode umschlossen 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

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

Hinweise

Die CompareTo-Methode wird durch Typen implementiert, deren Werte sortiert oder sortiert werden können. Sie wird automatisch durch Methoden von nicht generischen Auflistungsobjekten aufgerufen, z. B. Array.Sort, um jedes Element des Arrays zu ordnen. Wenn eine benutzerdefinierte Klasse oder Struktur keine IComparableimplementiert, können die Member nicht sortiert werden, und der Sortiervorgang kann eine InvalidOperationExceptionauslösen.

Diese Methode ist nur eine Definition und muss von einer bestimmten Klasse oder einem bestimmten Werttyp implementiert werden, um Wirkung zu haben. Die Bedeutung der im Abschnitt "Rückgabewert" angegebenen Vergleiche ("vorangestellt", "tritt an der gleichen Position wie" und "folgt") von der jeweiligen Implementierung ab.

Standardmäßig vergleicht jedes Objekt größer als (oder folgt) null, und zwei NULL-Bezüge werden miteinander verglichen.

Der Parameter objmuss den gleichen Typ wie die Klasse oder den Werttyp aufweisen, der diese Schnittstelle implementiert. andernfalls wird ein ArgumentException ausgelöst.

Hinweise für Ausführende

Für Objekte A, B und C muss Folgendes wahr sein:

A.CompareTo(A) muss Null zurückgeben.

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

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

Wenn A.CompareTo(B) einen anderen Wert als Null zurückgibt, muss B.CompareTo(A) einen Wert des entgegengesetzten Zeichens zurückgeben.

Wenn A.CompareTo(B) einen Wert "x" ungleich Null zurückgibt und B.CompareTo(C) einen Wert "y" desselben Zeichens wie "x" zurückgibt, muss A.CompareTo(C) einen Wert desselben Zeichens wie "x" und "y" zurückgeben.

Hinweise für Aufrufer

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

Gilt für:

Weitere Informationen

Object

Teilen über