IComparable.CompareTo(Object) Metod

Definition

Jämför den aktuella instansen med ett annat objekt av samma typ och returnerar ett heltal som anger om den aktuella instansen föregår, följer eller inträffar i samma position i sorteringsordningen som det andra objektet.

public:
 int CompareTo(System::Object ^ obj);
public int CompareTo(object obj);
public int CompareTo(object? obj);
abstract member CompareTo : obj -> int
Public Function CompareTo (obj As Object) As Integer

Parametrar

obj
Object

Ett objekt att jämföra med den här instansen.

Returer

Ett värde som anger den relativa ordningen för de objekt som jämförs. Returvärdet har följande betydelser:

Värde Menande
Mindre än noll Den här instansen föregås obj av sorteringsordningen.
Noll Den här instansen inträffar i samma position i sorteringsordningen som obj.
Större än noll Den här instansen följer obj i sorteringsordningen.

Undantag

obj är inte samma typ som den här instansen.

Exempel

I följande exempel visas hur du jämför CompareTo ett objekt som implementerar Temperature med ett IComparable annat objekt. Objektet Temperature implementeras CompareTo genom att bara omsluta ett anrop till Int32.CompareTo metoden.

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

Kommentarer

Metoden CompareTo implementeras av typer vars värden kan sorteras eller sorteras. Den anropas automatiskt med metoder för icke-generiska samlingsobjekt, till exempel Array.Sort, för att beställa varje medlem i matrisen. Om en anpassad klass eller struktur inte implementerar IComparablekan dess medlemmar inte ordnas och sorteringsåtgärden kan utlösa en InvalidOperationException.

Den här metoden är bara en definition och måste implementeras av en viss klass eller värdetyp för att få effekt. Innebörden av de jämförelser som anges i avsnittet Return Value ("precedes", "occurs in the same position as" och "follows") beror på den specifika implementeringen.

Per definition jämförs ett objekt som är större än (eller följer) nulloch två null-referenser är lika med varandra.

Parametern , objmåste vara av samma typ som den klass eller värdetyp som implementerar det här gränssnittet. Annars genereras en ArgumentException .

Anteckningar till implementerare

För objekten A, B och C måste följande vara sant:

A.CompareTo(A) måste returnera noll.

Om A.CompareTo(B) returnerar noll måste du B.CompareTo(A) returnera noll.

Om A.CompareTo(B) returnerar noll och B.CompareTo(C) returnerar noll måste du A.CompareTo(C) returnera noll.

Om A.CompareTo(B) returnerar ett annat värde än noll måste du B.CompareTo(A) returnera ett värde för det motsatta tecknet.

Om A.CompareTo(B) returnerar ett värde "x" som inte är lika med noll och B.CompareTo(C) returnerar ett värde "y" med samma tecken som "x", måste du A.CompareTo(C) returnera ett värde med samma tecken som "x" och "y".

Anteckningar till anropare

CompareTo(Object) Använd metoden för att fastställa ordningen på instanser av en klass.

Gäller för

Se även