IComparable<T> 介面

定義

命名空間:: System

組件:: mscorlib.dll, System.Runtime.dll

組件:: netstandard.dll, System.Runtime.dll

組件:: System.Runtime.dll

組件:: mscorlib.dll

組件:: netstandard.dll

來源:: IComparable.cs

來源:: IComparable.cs

來源:: Base64Decoder.cs

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

定義一種廣義比較方法，值型別或類別實作以建立特定型別的比較方法，用於排序或排序其實例。

generic <typename T>
public interface class IComparable

public interface IComparable<in T>

public interface IComparable<in T> where T : allows ref struct

public interface IComparable<T>

type IComparable<'T> = interface

Public Interface IComparable(Of In T)

Public Interface IComparable(Of T)

類型參數

T

要比較的物品類型。

這是反變數的型別參數。也就是說，您可以使用您指定的類型，或衍生程度較低的任何類型。如需共變數與反變數的詳細資訊，請參閱泛型中的共變數與反變數。

衍生: System.Boolean

System.Byte

System.Char

System.DateOnly

System.DateTime

更多…

範例

以下範例說明了對一個簡單IComparable<T>物件的實Temperature作。範例中建立了 SortedList<TKey,TValue> 一組帶有 Temperature 物件鍵的字串，並在列表中不按順序加入多對溫度和字串。在呼叫該 Add 方法時，集合 SortedList<TKey,TValue> 利用實 IComparable<T> 作來排序清單條目，然後依溫度遞增的順序顯示。

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.
*/

open System
open System.Collections.Generic

type Temperature(kelvins: double) =
    // The underlying temperature value.
    let mutable kelvins = kelvins

    do 
        if kelvins < 0. then
            invalidArg (nameof kelvins) "Temperature cannot be less than absolute zero."

    // Define the is greater than operator.
    static member op_GreaterThan (operand1: Temperature, operand2: Temperature) =
        operand1.CompareTo operand2 > 0

    // Define the is less than operator.
    static member op_LessThan (operand1: Temperature, operand2: Temperature) =
        operand1.CompareTo operand2 < 0

    // Define the is greater than or equal to operator.
    static member op_GreaterThanOrEqual (operand1: Temperature, operand2: Temperature) =
        operand1.CompareTo operand2 >= 0

    // Define the is less than or equal to operator.
    static member op_LessThanOrEqual (operand1: Temperature, operand2: Temperature) =
        operand1.CompareTo operand2 <= 0

    member _.Celsius =
        kelvins - 273.15

    member _.Kelvin
        with get () =
            kelvins
        and set (value) =
            if value < 0. then
                invalidArg (nameof value) "Temperature cannot be less than absolute zero."
            else
                kelvins <- value

    // Implement the generic CompareTo method with the Temperature
    // class as the Type parameter.
    member _.CompareTo(other: Temperature) =
        // If other is not a valid object reference, this instance is greater.
        match box other with
        | null -> 1
        | _ ->
            // The temperature comparison depends on the comparison of
            // the underlying Double values.
            kelvins.CompareTo(other.Kelvin)

    interface IComparable<Temperature> with
        member this.CompareTo(other) = this.CompareTo other

let temps = SortedList()

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

for kvp in temps do
    printfn $"{kvp.Value} is {kvp.Key.Celsius} degrees 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.

Imports System.Collections.Generic

Public Class Temperature
    Implements IComparable(Of Temperature)

    ' Implement the generic CompareTo method with the Temperature class 
    ' as the type parameter. 
    '
    Public Overloads Function CompareTo(ByVal other As Temperature) As Integer _
        Implements IComparable(Of Temperature).CompareTo

        ' If other is not a valid object reference, this instance is greater.
        If other Is Nothing Then Return 1
        
        ' The temperature comparison depends on the comparison of the
        ' the underlying Double values. 
        Return m_value.CompareTo(other.m_value)
    End Function
    
    ' Define the is greater than operator.
    Public Shared Operator >  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) > 0
    End Operator
    
    ' Define the is less than operator.
    Public Shared Operator <  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) < 0
    End Operator

    ' Define the is greater than or equal to operator.
    Public Shared Operator >=  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) >= 0
    End Operator
    
    ' Define the is less than operator.
    Public Shared Operator <=  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) <= 0
    End Operator

    ' The underlying temperature value.
    Protected m_value As Double = 0.0

    Public ReadOnly Property Celsius() As Double
        Get
            Return m_value - 273.15
        End Get
    End Property

    Public Property Kelvin() As Double
        Get
            Return m_value
        End Get
        Set(ByVal Value As Double)
            If value < 0.0 Then 
                Throw New ArgumentException("Temperature cannot be less than absolute zero.")
            Else
                m_value = Value
            End If
        End Set
    End Property

    Public Sub New(ByVal kelvins As Double)
        Me.Kelvin = kelvins 
    End Sub
End Class

Public Class Example
    Public Shared Sub Main()
        Dim temps As New SortedList(Of 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")

        For Each kvp As KeyValuePair(Of Temperature, String) In temps
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value, kvp.Key.Celsius)
        Next
    End Sub
End Class

' The 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.
'

備註

此介面由可排序或排序的型別實作，並提供一種強型別比較方法，用於排序通用集合物件的成員。例如，一個數字可能比第二個數字大，且一個字串可以按字母順序出現在另一個字串之前。它要求實作型別必須定義一個單一方法， CompareTo(T)該方法表示目前實例在排序順序中的位置是在同類型的第二個物件之前、之後還是相同。通常，這個方法不會直接從開發者程式碼中呼叫。取而代之的是，它會被自動呼叫，例如List<T>.Sort()Add和。

通常，提供實作的 IComparable<T> 型別也會實作該 IEquatable<T> 介面。介面 IEquatable<T> 定義了方法， Equals 決定實作型別實例的相等性。

該方法的實作 CompareTo(T) 必須回傳， Int32 其值為以下表格中三種之一。

價值觀	Meaning
低於零	此物件位於排序順序中由 CompareTo 方法指定的物件之前。
零	這個目前的實例在排序順序中與方法參數指定的 CompareTo 物件相同。
大於零	此當前實例依排序順序跟隨方法參數指定的 CompareTo 物件。

所有數值類型（如 Int32 和）都實作 Double，如同、 IComparable<T>String Char、。DateTime 自訂型態也應該提供自己的實作 IComparable<T> ，以使物件實例能夠被排序或排序。

給實施者的注意事項

將介面的 IComparable<T> 型別參數替換為實作該介面的型別參數。

如果你實作 IComparable<T>，應該會讓、 op_GreaterThan、 op_GreaterThanOrEqual和 op_LessThan 運算子多載op_LessThanOrEqual到與一致CompareTo(T)的值。此外，你也應該實作 IEquatable<T>。完整資訊請參閱該文章。IEquatable<T>

方法

名稱	Description
CompareTo(T)	比較目前實例與相同型別的另一個物件，並傳回整數，指出目前的實例是否在排序順序中與其他對象位於相同位置。

適用於

另請參閱

意見反應

此頁面對您有幫助嗎？