IComparable<T> Antarmuka

Definisi

Ruang nama:

System

Rakitan:

netstandard.dll, System.Runtime.dll

Sumber:

IComparable.cs

Menentukan metode perbandingan umum yang diterapkan jenis nilai atau kelas untuk membuat metode perbandingan khusus jenis untuk mengurutkan atau mengurutkan instansnya.

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)

Jenis parameter

T

Jenis objek yang akan dibandingkan.

Parameter jenis ini bersifat kontravarian. Artinya, Anda bisa menggunakan jenis yang Anda tentukan atau jenis apa pun yang tidak banyak diturunkan. Untuk informasi lebih lanjut tentang kovariansi dan kontravariansi, lihat Kovariansi dan Kontravariansi dalam Generik.

Turunan

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

Contoh

Contoh berikut mengilustrasikan implementasi IComparable<T> untuk objek sederhana Temperature . Contohnya membuat SortedList<TKey,TValue> kumpulan string dengan Temperature kunci objek, dan menambahkan beberapa pasang suhu dan string ke daftar di luar urutan. Dalam panggilan ke Add metode , SortedList<TKey,TValue> koleksi menggunakan IComparable<T> implementasi untuk mengurutkan entri daftar, yang kemudian ditampilkan dalam urutan peningkatan suhu.

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

Keterangan

Antarmuka ini diimplementasikan oleh jenis yang nilainya dapat diurutkan atau diurutkan dan menyediakan metode perbandingan yang sangat di ketik untuk mengurutkan anggota objek koleksi generik. Misalnya, satu angka dapat lebih besar dari angka kedua, dan satu string dapat muncul dalam urutan alfabet sebelum angka lainnya. Ini mengharuskan jenis penerapan menentukan satu metode, CompareTo(T), yang menunjukkan apakah posisi instans saat ini dalam urutan pengurutan adalah sebelum, setelah, atau sama dengan objek kedua dengan jenis yang sama. Biasanya, metode ini tidak dipanggil langsung dari kode pengembang. Sebaliknya, ini dipanggil secara otomatis oleh metode seperti List<T>.Sort() dan Add.

Biasanya, jenis yang menyediakan IComparable<T> implementasi juga mengimplementasikan IEquatable<T> antarmuka. Antarmuka IEquatable<T> mendefinisikan Equals metode , yang menentukan kesetaraan instans dari jenis penerapan.

Implementasi CompareTo(T) metode harus mengembalikan yang Int32 memiliki salah satu dari tiga nilai, seperti yang ditunjukkan dalam tabel berikut.

Nilai	Makna
Kurang dari nol	Objek ini mendahului objek yang ditentukan oleh CompareTo metode dalam urutan pengurutan.
Nol	Instans saat ini terjadi dalam posisi yang sama dalam urutan pengurutan sebagai objek yang ditentukan oleh CompareTo argumen metode.
Lebih besar dari nol	Instans saat ini mengikuti objek yang ditentukan oleh CompareTo argumen metode dalam urutan pengurutan.

Semua jenis numerik (seperti Int32 dan Double) mengimplementasikan IComparable<T>, seperti halnya String, Char, dan DateTime. Jenis kustom juga harus menyediakan implementasinya IComparable<T> sendiri untuk memungkinkan instans objek diurutkan atau diurutkan.

Catatan Bagi Implementer

Ganti parameter IComparable<T> jenis antarmuka dengan jenis yang mengimplementasikan antarmuka ini.

Jika Anda menerapkan IComparable<T>, Anda harus membebani op_GreaterThanoperator , , op_GreaterThanOrEqualop_LessThan, dan op_LessThanOrEqual untuk mengembalikan nilai yang konsisten dengan CompareTo(T). Selain itu, Anda juga harus menerapkan IEquatable<T>. IEquatable<T> Lihat artikel untuk informasi lengkap.

Metode

Nama	Deskripsi
CompareTo(T)	Membandingkan instans saat ini dengan objek lain dengan jenis yang sama dan mengembalikan bilangan bulat yang menunjukkan apakah instans saat ini mendahului, mengikuti, atau terjadi dalam posisi yang sama dalam urutan pengurutan seperti objek lainnya.

Lihat juga

• IComparable
• IEquatable<T>