IComparable.CompareTo(Object) Metode

Definisi

Ruang nama:

System

Rakitan:

netstandard.dll, System.Runtime.dll

Sumber:

IComparable.cs

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.

public:
 int CompareTo(System::Object ^ obj);

public int CompareTo(object? obj);

abstract member CompareTo : obj -> int

Public Function CompareTo (obj As Object) As Integer

Parameter

obj

Object

Objek untuk dibandingkan dengan instans ini.

Mengembalikan

Int32

Nilai yang menunjukkan urutan relatif objek yang dibandingkan. Nilai yang dikembalikan memiliki arti ini:

Nilai	Makna
Kurang dari nol	Instans ini mendahului obj dalam urutan pengurutan.
Nol	Instans ini terjadi dalam posisi yang sama dalam urutan pengurutan sebagai obj.
Lebih besar dari nol	Instans obj ini mengikuti dalam urutan pengurutan.

Pengecualian

ArgumentException

obj bukan tipe yang sama dengan instans ini.

Contoh

Contoh berikut mengilustrasikan penggunaan CompareTo untuk membandingkan objek yang Temperature diimplementasikan IComparable dengan objek lain. Objek mengimplementasikan Temperature hanya dengan membungkus CompareTo panggilan ke Int32.CompareTo metode .

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

Keterangan

Metode CompareTo ini diimplementasikan berdasarkan jenis yang nilainya dapat diurutkan atau diurutkan. Ini dipanggil secara otomatis dengan metode objek koleksi non-generik, seperti Array.Sort, untuk mengurutkan setiap anggota array. Jika kelas atau struktur kustom tidak menerapkan IComparable, anggotanya tidak dapat diurutkan dan operasi pengurutan dapat melempar InvalidOperationException.

Metode ini hanya definisi dan harus diimplementasikan oleh kelas atau jenis nilai tertentu agar berpengaruh. Arti perbandingan yang ditentukan di bagian Nilai Pengembalian ("mendahului", "terjadi dalam posisi yang sama dengan", dan "mengikuti") tergantung pada implementasi tertentu.

Menurut definisi, objek apa pun membandingkan lebih besar dari (atau berikut) null, dan dua referensi null dibandingkan satu sama lain.

Parameter, obj, harus sama dengan jenis kelas atau nilai yang mengimplementasikan antarmuka ini; jika tidak, maka ArgumentException akan dilemparkan.

Catatan Bagi Implementer

Untuk objek A, B, dan C, berikut ini harus benar:

A.CompareTo(A) harus mengembalikan nol.

Jika A.CompareTo(B) mengembalikan nol, maka B.CompareTo(A) harus mengembalikan nol.

Jika A.CompareTo(B) mengembalikan nol dan B.CompareTo(C) mengembalikan nol, maka A.CompareTo(C) harus mengembalikan nol.

Jika A.CompareTo(B) mengembalikan nilai selain nol, maka B.CompareTo(A) harus mengembalikan nilai tanda berlawanan.

Jika A.CompareTo(B) mengembalikan nilai "x" yang tidak sama dengan nol, dan B.CompareTo(C) mengembalikan nilai "y" dari tanda yang sama dengan "x", maka A.CompareTo(C) harus mengembalikan nilai dengan tanda yang sama dengan "x" dan "y".

Catatan Bagi Pemanggil

CompareTo(Object) Gunakan metode untuk menentukan urutan instans kelas.

Lihat juga

• Object