IComparable.CompareTo(Object) Метод

Определение

Сравнивает текущий экземпляр с другим объектом того же типа и возвращает целое число, которое показывает, расположен ли текущий экземпляр перед, после или на той же позиции в порядке сортировки, что и другой объект.

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

Параметры

obj
Object

Объект для сравнения с данным экземпляром.

Возвращаемое значение

Int32

Значение, указывающее, каков относительный порядок сравниваемых объектов. Возвращаемые значения представляют следующие результаты сравнения.

Значение Значение
Меньше нуля Данный экземпляр предшествует параметру obj в порядке сортировки.
Нуль Данный экземпляр занимает ту же позицию в порядке сортировки, что и параметр obj.
Больше нуля Данный экземпляр следует за параметром obj в порядке сортировки.

Исключения

Тип значения параметра obj отличается от типа данного экземпляра.

Примеры

В следующем примере показано использование функции CompareTo для сравнения объекта, Temperature реализующего IComparable с другим объектом. TemperatureОбъект реализуется CompareTo простым созданием оболочки вызова Int32.CompareTo метода.

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

Комментарии

CompareToМетод реализуется типами, значения которых могут быть упорядочены или отсортированы. Он вызывается автоматически методами объектов неуниверсальной коллекции, например Array.Sort , для упорядочения каждого элемента массива. Если пользовательский класс или структура не реализует, то IComparable его члены не могут быть упорядочены, а операция сортировки может вызывать исключение InvalidOperationException .

Этот метод является только определением и должен быть реализован конкретным классом или типом значения, чтобы иметь результат. Значение сравнений, указанных в разделе возвращаемое значение ("предшествует", "выполняется в той же области, что и", а "ниже"), зависит от конкретной реализации.

По определению любой объект сравнивается больше (или за ним) null , а две пустые ссылки сравниваются равными друг другу.

Параметр obj должен иметь тот же тип, что и класс или тип значения, который реализует этот интерфейс; в противном случае ArgumentException создается исключение.

Примечания для тех, кто реализует этот метод

Для объектов A, B и C должны выполняться следующие условия: А. CompareTo (a) должен возвращать ноль.

Если A. CompareTo (B) возвращает ноль, то B. CompareTo (A) должно возвращать ноль.

Если a. CompareTo (B) возвращает ноль, а B. CompareTo (c) возвращает ноль, то A. CompareTo (c) должен возвращать ноль.

Если A. CompareTo (B) возвращает значение, отличное от нуля, то B. CompareTo (A) должно возвращать значение противоположного знака.

Если a. CompareTo (b) возвращает значение, x не равное нулю, а B. CompareTo (C) возвращает значение того y же знака x , что и. метод . CompareTo (c) должен возвращать значение того же знака, что x и y .

Примечания для тех, кто вызывает этот метод

Используйте CompareTo(Object) метод, чтобы определить порядок экземпляров класса.

Применяется к

См. также раздел