IComparable<T>.CompareTo(T) Methode

Definition

Namespace:

System

Assemblys:

netstandard.dll, System.Runtime.dll

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.

C#

public int CompareTo(T? other);

Parameter

other

T

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 other.
Zero	Diese Instanz tritt in der Sortierreihenfolge an der gleichen Position wie other auf.
Größer als 0 (null)	Diese Instanz folgt in der Sortierreihenfolge auf other.

Beispiele

Das folgende Codebeispiel veranschaulicht die Implementierung von IComparable<T> für ein einfaches Temperature Objekt. Im Beispiel wird eine SortedList<TKey,TValue> Auflistung von Zeichenfolgen mit Temperature Objektschlüsseln erstellt und der Liste aus der Sequenz mehrere Temperatur- und Zeichenfolgenpaare hinzugefügt. Beim Aufruf der Add -Methode verwendet die Auflistung die SortedList<TKey,TValue>IComparable<T> Implementierung, um die Listeneinträge zu sortieren, die dann in der Reihenfolge der Temperaturerhöhung angezeigt werden.

C#

using System;
using System.Collections.Generic;

public class Temperature : IComparable<Temperature>
{
    // Implement the generic CompareTo method with the Temperature
    // class as the Type parameter.
    //
    public int CompareTo(Temperature other)
    {
        // If other is not a valid object reference, this instance is greater.
        if (other == null) return 1;

        // The temperature comparison depends on the comparison of
        // the underlying Double values.
        return m_value.CompareTo(other.m_value);
    }

    // Define the is greater than operator.
    public static bool operator >  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) > 0;
    }

    // Define the is less than operator.
    public static bool operator <  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) < 0;
    }

    // Define the is greater than or equal to operator.
    public static bool operator >=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) >= 0;
    }

    // Define the is less than or equal to operator.
    public static bool operator <=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) <= 0;
    }

    // The underlying temperature value.
    protected double m_value = 0.0;

    public double Celsius
    {
        get
        {
            return m_value - 273.15;
        }
    }

    public double Kelvin
    {
        get
        {
            return m_value;
        }
        set
        {
            if (value < 0.0)
            {
                throw new ArgumentException("Temperature cannot be less than absolute zero.");
            }
            else
            {
                m_value = value;
            }
        }
    }

    public Temperature(double kelvins)
    {
        this.Kelvin = kelvins;
    }
}

public class Example
{
    public static void Main()
    {
        SortedList<Temperature, string> temps =
            new SortedList<Temperature, string>();

        // Add entries to the sorted list, out of order.
        temps.Add(new Temperature(2017.15), "Boiling point of Lead");
        temps.Add(new Temperature(0), "Absolute zero");
        temps.Add(new Temperature(273.15), "Freezing point of water");
        temps.Add(new Temperature(5100.15), "Boiling point of Carbon");
        temps.Add(new Temperature(373.15), "Boiling point of water");
        temps.Add(new Temperature(600.65), "Melting point of Lead");

        foreach( KeyValuePair<Temperature, string> kvp in temps )
        {
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value, kvp.Key.Celsius);
        }
    }
}
/* This example displays the following output:
      Absolute zero is -273.15 degrees Celsius.
      Freezing point of water is 0 degrees Celsius.
      Boiling point of water is 100 degrees Celsius.
      Melting point of Lead is 327.5 degrees Celsius.
      Boiling point of Lead is 1744 degrees Celsius.
      Boiling point of Carbon is 4827 degrees Celsius.
*/

Hinweise

CompareTo stellt eine stark typisierte Vergleichsmethode zum Sortieren von Membern eines generischen Auflistungsobjekts bereit. Aus diesem Grund wird es in der Regel nicht direkt aus Entwicklercode aufgerufen. Stattdessen wird sie automatisch von Methoden wie List<T>.Sort() und Addaufgerufen.

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

Definitionsgemäß vergleicht jedes Objekt größer als null, und zwei NULL-Verweise vergleichen sich gleich.

Hinweise für Ausführende

Für die Objekte A, B und C muss Folgendes zutrifft:

A.CompareTo(A) ist erforderlich, um null zurückzugeben.

Wenn A.CompareTo(B) null zurückgegeben wird, B.CompareTo(A) muss null zurückgegeben werden.

Wenn A.CompareTo(B) null und B.CompareTo(C) null zurückgegeben wird, muss null A.CompareTo(C) zurückgegeben werden.

Wenn A.CompareTo(B) ein anderer Wert als null zurückgegeben wird, B.CompareTo(A) muss ein Wert des entgegengesetzten Vorzeichens zurückgegeben werden.

Wenn A.CompareTo(B) ein Wert x zurückgegeben wird, der nicht gleich 0 ist, und B.CompareTo(C) einen Wert y mit demselben Vorzeichen wie xzurückgibt, A.CompareTo(C) ist erforderlich, um einen Wert mit demselben Vorzeichen wie x und yzurückzugeben.

Hinweise für Aufrufer

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

Gilt für:

Weitere Informationen

• Object
• IComparable