IComparable.CompareTo(Object) Metódus

Definíció

Névtér:

System

Szerelvények:

netstandard.dll, System.Runtime.dll

Forrás:

IComparable.cs

Összehasonlítja az aktuális példányt egy másik, azonos típusú objektummal, és egy egész számot ad vissza, amely azt jelzi, hogy az aktuális példány megelőzi, követi vagy ugyanabban a sorrendben fordul elő, mint a másik objektum.

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

public int CompareTo(object? obj);

abstract member CompareTo : obj -> int

Public Function CompareTo (obj As Object) As Integer

Paraméterek

obj

Object

Ezzel a példánysal összehasonlítandó objektum.

Válaszok

Int32

Az összehasonlítandó objektumok relatív sorrendjét jelző érték. A visszatérési érték a következő jelentéssel rendelkezik:

Érték	Jelentése
Nullánál kisebb	Ez a példány megelőzi obj a rendezési sorrendet.
Nulla	Ez a példány ugyanabban a sorrendben fordul elő, mint obja .
Nullánál nagyobb	Ez a példány a rendezési sorrendben következik obj .

Kivételek

ArgumentException

obj nem ugyanaz a típus, mint ez a példány.

Példák

Az alábbi példa azt szemléltetiCompareTo, hogy egy implementálási Temperature objektum összehasonlítása egy IComparable másik objektummal. Az Temperature objektum úgy valósítja meg a implementálást CompareTo , hogy egyszerűen körbefuttat egy hívást a Int32.CompareTo metódushoz.

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

Megjegyzések

A CompareTo metódust olyan típusok implementálják, amelyek értékei rendezhetők vagy rendezhetők. A rendszer automatikusan meghívja a nem általános gyűjteményobjektumok metódusai, például Array.Sorta tömb egyes részeinek sorrendje alapján. Ha egy egyéni osztály vagy struktúra nem implementálható IComparable, a tagok nem rendezhetők, és a rendezési művelet egy InvalidOperationException.

Ez a módszer csak definíció, és egy adott osztály vagy értéktípus alkalmazásával kell megvalósítani, hogy érvénybe lépjen. A Visszatérési érték szakaszban megadott összehasonlítások jelentése ("precedes", "ugyanabban a helyzetben történik, mint", és a "következő") az adott megvalósítástól függ.

Definíció szerint minden objektum nagyobb, mint (vagy követi) nullés két nullhivatkozás egyenlő egymással.

A paraméternek ugyanazzal a típussal kell rendelkeznie, objmint az interfészt megvalósító osztály- vagy értéktípus; ellenkező esetben a rendszer eldobja a paramétert ArgumentException .

Megjegyzések az implementálókhoz

Az A, B és C objektumok esetében a következőknek kell igaznak lenniük:

A.CompareTo(A) nullát kell visszaadnia.

Ha A.CompareTo(B) nullát ad vissza, akkor B.CompareTo(A) nullát kell visszaadnia.

Ha A.CompareTo(B) nullát ad vissza, és B.CompareTo(C) nullát ad vissza, akkor A.CompareTo(C) nullát kell visszaadnia.

Ha A.CompareTo(B) nullától eltérő értéket ad vissza, akkor B.CompareTo(A) az ellenkező előjelű értéket kell visszaadnia.

Ha A.CompareTo(B) "x" értéket ad vissza, amely nem egyenlő nullával, és B.CompareTo(C) egy "y" értéket ad vissza az "x" jellel azonos előjellel, akkor A.CompareTo(C) az "x" és az "y" előjellel megegyező értéket kell visszaadnia.

Megjegyzések a hívókhoz

A metódussal CompareTo(Object) meghatározhatja egy osztály példányainak sorrendjét.

Lásd még

• Object