IComparable.CompareTo(Object) Metoda

Definicja

Porównuje bieżące wystąpienie z innym obiektem tego samego typu i zwraca liczbę całkowitą, która wskazuje, czy bieżące wystąpienie poprzedza, następuje po lub występuje w tym samym położeniu, co inny obiekt w porządku sortowania.Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

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

Parametry

obj
Object

Obiekt, który ma zostać porównany z tym wystąpieniem.An object to compare with this instance.

Zwraca

Wartość, która wskazuje względną kolejność porównywanych obiektów.A value that indicates the relative order of the objects being compared. Wartość zwracana ma następujące znaczenie:The return value has these meanings:

WartośćValue ZnaczenieMeaning
Mniej niż zeroLess than zero To wystąpienie poprzedza obj porządek sortowania.This instance precedes obj in the sort order.
ZeroZero To wystąpienie występuje w tym samym położeniu w kolejności sortowania, objjak.This instance occurs in the same position in the sort order as obj.
Większe od zeraGreater than zero To wystąpienie następuje obj w kolejności sortowania.This instance follows obj in the sort order.

Wyjątki

objnie jest tym samym typem co to wystąpienie.obj is not the same type as this instance.

Przykłady

Poniższy przykład ilustruje sposób użycia programu CompareTo w celu Temperature porównania obiektu implementującego IComparable z innym obiektem.The following example illustrates the use of CompareTo to compare a Temperature object implementing IComparable with another object. Obiekt Temperature jest implementowany CompareTo przez po prostu Int32.CompareTo zawija wywołanie metody.The Temperature object implements CompareTo by simply wrapping a call to the Int32.CompareTo method.

using namespace System;
using namespace System::Collections;

public ref class Temperature: public IComparable {
   /// <summary>
   /// IComparable.CompareTo implementation.
   /// </summary>
protected:
   // The value holder
   Double m_value;

public:
   virtual Int32 CompareTo( Object^ obj ) {
   
      if (obj == nullptr) return 1;
      
      if ( obj->GetType() == Temperature::typeid ) {
         Temperature^ temp = dynamic_cast<Temperature^>(obj);

         return m_value.CompareTo( temp->m_value );
      }
      throw gcnew ArgumentException(  "object is not a Temperature" );
   }

   property Double Value {
      Double get() {
         return m_value;
      }
      void set( Double value ) {
         m_value = value;
      }
   }

   property Double Celsius  {
      Double get() {
         return (m_value - 32) / 1.8;
      }
      void set( Double value ) {
         m_value = (value * 1.8) + 32;
      }
   }
};

int main()
{
   ArrayList^ temperatures = gcnew ArrayList;
   // Initialize random number generator.
   Random^ rnd = gcnew Random;

   // Generate 10 temperatures between 0 and 100 randomly.
   for (int ctr = 1; ctr <= 10; ctr++)
   {
      int degrees = rnd->Next(0, 100);
      Temperature^ temp = gcnew Temperature;
      temp->Value = degrees;
      temperatures->Add(temp);
   }

   // Sort ArrayList.
   temperatures->Sort();
      
   for each (Temperature^ temp in temperatures)
      Console::WriteLine(temp->Value);
   return 0;
}
// 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
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
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

Uwagi

CompareTo Metoda jest implementowana przez typy, których wartości mogą być uporządkowane lub sortowane.The CompareTo method is implemented by types whose values can be ordered or sorted. Jest on wywoływany automatycznie przez metody obiektów kolekcji innych niż ogólne, takie jak Array.Sort, aby zamówić każdy element członkowski tablicy.It is called automatically by methods of non-generic collection objects, such as Array.Sort, to order each member of the array. Jeśli niestandardowa Klasa lub struktura nie implementuje IComparable, jego składowe nie mogą być uporządkowane i operacja sortowania może InvalidOperationExceptionzgłosić.If a custom class or structure does not implement IComparable, its members cannot be ordered and the sort operation can throw an InvalidOperationException.

Ta metoda jest tylko definicją i musi być implementowana przez określoną klasę lub typ wartości, aby mieć efekt.This method is only a definition and must be implemented by a specific class or value type to have effect. Znaczenie porównania określone w sekcji wartości zwracanej ("poprzedza", "występuje w tym samym położeniu co" i "dalej") zależy od określonej implementacji.The meaning of the comparisons specified in the Return Value section ("precedes", "occurs in the same position as", and "follows") depends on the particular implementation.

Według definicji, każdy obiekt porównuje więcej niż (lub następuje null), a dwa odwołania o wartości null są porównywane ze sobą.By definition, any object compares greater than (or follows) null, and two null references compare equal to each other.

Parametr, obj, musi być tego samego typu co Klasa lub typ wartości implementujący ten interfejs; w przeciwnym razie ArgumentException jest zgłaszany.The parameter, obj, must be the same type as the class or value type that implements this interface; otherwise, an ArgumentException is thrown.

Uwagi dotyczące implementowania

Dla obiektów A, B i C, muszą być spełnione następujące wartości:For objects A, B and C, the following must be true: A. CompareTo (a) musi zwracać zero.A.CompareTo(A) must return zero.

Jeśli A. CompareTo (B) zwraca zero, wówczas B. CompareTo (A) musi zwracać zero.If A.CompareTo(B) returns zero, then B.CompareTo(A) must return zero.

Jeśli a. CompareTo (B) zwraca zero i B. CompareTo (c) zwraca zero, a a. CompareTo (C) musi zwracać zero.If A.CompareTo(B) returns zero and B.CompareTo(C) returns zero, then A.CompareTo(C) must return zero.

Jeśli A. CompareTo (B) zwraca wartość inną niż zero, wówczas B. CompareTo (A) musi zwracać wartość przeciwległego znaku.If A.CompareTo(B) returns a value other than zero, then B.CompareTo(A) must return a value of the opposite sign.

Jeśli CompareTo (b) zwraca wartość x różną od zera, a B. CompareTo (c) zwraca wartość y tego samego znaku xco, a a . CompareTo (c) musi zwracać wartość tego samego znaku co x i y.If A.CompareTo(B) returns a value x not equal to zero, and B.CompareTo(C) returns a value y of the same sign as x, then A.CompareTo(C) must return a value of the same sign as x and y.

Uwagi dotyczące wywoływania

CompareTo(Object) Użyj metody, aby określić kolejność wystąpień klasy.Use the CompareTo(Object) method to determine the ordering of instances of a class.

Dotyczy

Zobacz też