IComparable<T> Интерфейс

Определение

Пространство имен:

System

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

IComparable.cs

Определяет обобщенный метод сравнения, который реализует тип значения или класс для создания метода сравнения с определенным типом для упорядочивания или сортировки его экземпляров.

generic <typename T>
public interface class IComparable

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

type IComparable<'T> = interface

Public Interface IComparable(Of In T)

Параметры типа

T

Тип объекта для сравнения.

Это контравариантный параметр типа. Это означает, что вы можете использовать любой из указанных типов или любой тип, являющийся менее производным. Дополнительные сведения о ковариантности и контрвариантности см. в статье Ковариантность и контрвариантность в универсальных шаблонах.

Производный

System.Boolean

System.Byte

System.Char

System.DateOnly

System.DateTime

System.DateTimeOffset

System.Decimal

System.Double

System.Guid

System.Half

System.Int128

System.Int16

System.Int32

System.Int64

System.IntPtr

System.IO.Log.SequenceNumber

System.Numerics.BFloat16

System.Numerics.BigInteger

System.Numerics.IBinaryFloatingPointIeee754<TSelf>

System.Numerics.IBinaryInteger<TSelf>

System.Numerics.IBinaryNumber<TSelf>

System.Numerics.IFloatingPoint<TSelf>

System.Numerics.IFloatingPointIeee754<TSelf>

System.Numerics.INumber<TSelf>

System.Runtime.InteropServices.NFloat

System.SByte

System.Security.Principal.SecurityIdentifier

System.ServiceModel.Discovery.DiscoveryMessageSequence

System.Single

System.String

System.Text.Rune

System.TimeOnly

System.TimeSpan

System.UInt128

System.UInt16

System.UInt32

System.UInt64

System.UIntPtr

System.ValueTuple

System.ValueTuple<T1>

System.ValueTuple<T1,T2>

System.ValueTuple<T1,T2,T3>

System.ValueTuple<T1,T2,T3,T4>

System.ValueTuple<T1,T2,T3,T4,T5>

System.ValueTuple<T1,T2,T3,T4,T5,T6>

System.ValueTuple<T1,T2,T3,T4,T5,T6,T7>

System.ValueTuple<T1,T2,T3,T4,T5,T6,T7,TRest>

System.Version

Примеры

В следующем примере показана реализация простого 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, как показано в следующей таблице.

Ценность	Значение
Меньше нуля	Этот объект предшествует объекту, CompareTo указанному методом в порядке сортировки.
Ноль	Этот текущий экземпляр находится в той же позиции в порядке сортировки, что и объект, указанный аргументом CompareTo метода.
Больше нуля	Этот текущий экземпляр следует объекту, CompareTo указанному аргументом метода в порядке сортировки.

Все числовые типы (например, иInt32) реализуют Double, как и IComparable<T>String, и Char.DateTime Пользовательские типы также должны предоставлять собственную реализацию IComparable<T> , чтобы разрешить упорядочению или сортировке экземпляров объектов.

Примечания для тех, кто реализует этот метод

Замените параметр IComparable<T> типа интерфейса типом, реализующим этот интерфейс.

При реализации IComparable<T>необходимо перегрузить op_GreaterThanop_GreaterThanOrEqualоператоры и op_LessThanop_LessThanOrEqual операторы, чтобы возвращать значения, которые соответствуютCompareTo(T). Кроме того, следует также реализовать IEquatable<T>. Полные сведения см. в IEquatable<T> статье.

Методы

Имя	Описание
CompareTo(T)	Сравнивает текущий экземпляр с другим объектом того же типа и возвращает целое число, указывающее, следует ли текущий экземпляр или находится в той же позиции в порядке сортировки, что и другой объект.

См. также раздел

• IComparable
• IEquatable<T>