IComparable.CompareTo

.NET Framework クラス ライブラリ リファレンス

IComparable.CompareTo メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

現在のオブジェクトを同じ型の別のオブジェクトと比較します。

名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Function CompareTo ( _
    other As T _
) As Integer

Visual Basic (使用法)

Dim instance As IComparable(Of
 T)
Dim other As T
Dim returnValue As Integer

returnValue = instance.CompareTo(other)

C#

int CompareTo (
    T other
)

C++

int CompareTo (
    T other
)

J#

int CompareTo (
    T other
)

JScript

function CompareTo (
    other : T
) : int

パラメータ

other

このオブジェクトと比較するオブジェクト。

戻り値
比較対象オブジェクトの相対順序を示す 32 ビット符号付き整数。戻り値の意味は次のとおりです。

値	意味
0 より小さい値	このオブジェクトが other パラメータより小さいことを意味します。
0	このオブジェクトが other と等しいことを意味します。
0 より大きい値	このオブジェクトが other よりも大きいことを意味します。

解説

このメソッドは定義するだけなので、実際に使用する場合は、特定のクラスや値で実装する必要があります。比較における "より小さい"、"等価"、および "より大きい" の意味は、個別の実装によって異なります。

定義により、すべてのオブジェクトは null 参照 (Visual Basic では Nothing) よりも大きく、また 2 つの null 参照は互いに等しくなります。

実装時の注意 オブジェクト A、B、C について、次の条件が満たされる必要があります。 A.CompareTo(A) は 0 を返す必要があります。 A.CompareTo(B) が 0 を返す場合は、B.CompareTo(A) も 0 を返す必要があります。 A.CompareTo(B) が 0 を返し、B.CompareTo(C) が 0 を返す場合は、A.CompareTo(C) も 0 を返す必要があります。 A.CompareTo(B) が 0 以外の値を返す場合、B.CompareTo(A) は反対の符号の値を返す必要があります。 A.CompareTo(B) が 0 でない値 x を返し、B.CompareTo(C) が x と同じ符号の値 y を返す場合、A.CompareTo(C) は x および y と同じ符号の値を返す必要があります。

呼び出し時の注意 CompareTo メソッドを使用して、クラスのインスタンスの順序を決定します。

使用例

簡単な Temperature オブジェクトに IComparable を実装するコード例を次に示します。この例では、Temperature オブジェクトのキーを保持する文字列の SortedList コレクションを作成し、気温と文字列から成る複数のペアをランダムにリストに追加します。SortedList コレクションでは、IComparable の実装を使用して、リストのエントリを気温の昇順に並べ替えています。

Visual Basic

Imports System
Imports System.Collections.Generic

Public Class Temperature
    Implements IComparable(Of Temperature)

    ' Implement the generic CompareTo method. In the Implements statement
,
    ' specify the Temperature class for the type parameter of the
    ' generic IComparable interface. Use that type for the parameter
    ' of the CompareTo method.
    '
    Public Overloads Function
 CompareTo(ByVal other As Temperature) As
 Integer _
        Implements IComparable(Of Temperature).CompareTo

        ' The temperature comparison depends on the comparison of the
        ' the underlying Double values. Because the CompareTo method
 is
        ' strongly typed, it is not necessary to test for the correct
        ' object type.
        Return m_value.CompareTo(other.m_value)
    End Function

    ' The underlying temperature value.
    Protected m_value As Double
 = 0.0

    Public ReadOnly Property
 Celsius() As Double
        Get
            Return m_value - 273.15
        End Get
    End Property

    Public Property Kelvin() As
 Double
        Get
            Return m_value
        End Get
        Set(ByVal Value As
 Double)
            If value < 0.0 Then 
                Throw New ArgumentException("Temperature
 cannot be less than absolute zero.")
            Else
                m_value = Value
            End If
        End Set
    End Property

    Public Sub New(ByVal
 degreesKelvin As Double)
        Me.Kelvin = degreesKelvin 
    End Sub
End Class

Public Class Example
    Public Shared Sub Main()
        Dim temps As New
 SortedList(Of Temperature, String)

        ' Add entries to the sorted list, out of order.
        temps.Add(New Temperature(2017.15), "Boiling
 point of Lead")
        temps.Add(New Temperature(0), "Absolute
 zero")
        temps.Add(New Temperature(273.15), "Freezing
 point of water")
        temps.Add(New Temperature(5100.15), "Boiling
 point of Carbon")
        temps.Add(New Temperature(373.15), "Boiling
 point of water")
        temps.Add(New Temperature(600.65), "Melting
 point of Lead")

        For Each kvp As
 KeyValuePair(Of Temperature, String) In
 temps
            Console.WriteLine("{0} is {1} degrees Celsius.",
 kvp.Value, kvp.Key.Celsius)
        Next
    End Sub
End Class

' This code example produces the following output:
'
'Absolute zero is -273.15 degrees Celsius.
'Freezing point of water is 0 degrees Celsius.
'Boiling point of water is 100 degrees Celsius.
'Melting point of Lead is 327.5 degrees Celsius.
'Boiling point of Lead is 1744 degrees Celsius.
'Boiling point of Carbon is 4827 degrees Celsius.
'

C#

using System;
using System.Collections.Generic;

public class Temperature : IComparable<Temperature>
{
    // Implement the CompareTo method. For the parameter type, Use 
    // the type specified for the type parameter of the generic 
    // IComparable interface. 
    //
    public int CompareTo(Temperature other)
    {
        // The temperature comparison depends on the comparison of the
        // the underlying Double values. Because the CompareTo method
 is
        // strongly typed, it is not necessary to test for the correct
        // object type.
        return m_value.CompareTo(other.m_value);
    }

    // The underlying temperature value.
    protected double m_value = 0.0;

    public double Celsius    
    {
        get
        {
            return m_value - 273.15;
        }
    }

    public double Kelvin    
    {
        get
        {
            return m_value;
        }
        set
        {
            if (value < 0.0)
            {
                throw new ArgumentException("Temperature
 cannot be less than absolute zero.");
            }
            else
            {
                m_value = value;
            }
        }
    }

    public Temperature(double degreesKelvin)
    {
        this.Kelvin = degreesKelvin;
    }
}

public class Example
{
    public static void Main()
    {
        SortedList<Temperature, string> temps = 
            new SortedList<Temperature, string>();

        // Add entries to the sorted list, out of order.
        temps.Add(new Temperature(2017.15), "Boiling point
 of Lead");
        temps.Add(new Temperature(0), "Absolute zero");
        temps.Add(new Temperature(273.15), "Freezing point
 of water");
        temps.Add(new Temperature(5100.15), "Boiling point
 of Carbon");
        temps.Add(new Temperature(373.15), "Boiling point
 of water");
        temps.Add(new Temperature(600.65), "Melting point
 of Lead");

        foreach( KeyValuePair<Temperature, string>
 kvp in temps )
        {
            Console.WriteLine("{0} is {1} degrees Celsius.", kvp.Value,
 kvp.Key.Celsius);
        }
    }
}

/* This code example produces the following output:

Absolute zero is -273.15 degrees Celsius.
Freezing point of water is 0 degrees Celsius.
Boiling point of water is 100 degrees Celsius.
Melting point of Lead is 327.5 degrees Celsius.
Boiling point of Lead is 1744 degrees Celsius.
Boiling point of Carbon is 4827 degrees Celsius.

*/

C++

#using <System.dll>

using namespace System;
using namespace System::Collections::Generic;

public ref class Temperature: public
 IComparable<Temperature^> {

protected:
   // The value holder
   Double m_value;

public:
   // Implement the CompareTo method. For the parameter type, Use 
   // the type specified for the type parameter of the generic 
   // IComparable interface. 
   //
   virtual Int32 CompareTo( Temperature^ other ) {

      // The temperature comparison depends on the comparison of the
      // the underlying Double values. Because the CompareTo method
 is
      // strongly typed, it is not necessary to test for the correct
      // object type.
      return m_value.CompareTo( other->m_value );
   }

   property Double Celsius {
      Double get() {
         return m_value + 273.15;
      }
   }

   property Double Kelvin {
      Double get() {
         return m_value;
      }
      void set( Double value ) {
         if (value < 0)
            throw gcnew ArgumentException("Temperature cannot be less than absolute
 zero.");
         else
            m_value = value;
      }
   }

   Temperature(Double degreesKelvin) {
      this->Kelvin = degreesKelvin;
   }
};

int main() {
   SortedList<Temperature^, String^>^ temps = 
      gcnew SortedList<Temperature^, String^>();

   // Add entries to the sorted list, out of order.
   temps->Add(gcnew Temperature(2017.15), "Boiling point of Lead");
   temps->Add(gcnew Temperature(0), "Absolute zero");
   temps->Add(gcnew Temperature(273.15), "Freezing point of water");
   temps->Add(gcnew Temperature(5100.15), "Boiling point of Carbon");
   temps->Add(gcnew Temperature(373.15), "Boiling point of water");
   temps->Add(gcnew Temperature(600.65), "Melting point of Lead");

   for each( KeyValuePair<Temperature^, String^>^ kvp in
 temps )
   {
      Console::WriteLine("{0} is {1} degrees Celsius.", kvp->Value,
 kvp->Key->Celsius);
   }
}

/* This code example productes the following output:

Absolute zero is 273.15 degrees Celsius.
Freezing point of water is 546.3 degrees Celsius.
Boiling point of water is 646.3 degrees Celsius.
Melting point of Lead is 873.8 degrees Celsius.
Boiling point of Lead is 2290.3 degrees Celsius.
Boiling point of Carbon is 5373.3 degrees Celsius.

*/

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
IComparable ジェネリック インターフェイス
IComparable メンバ
System 名前空間
Object
IComparable インターフェイス

IComparable.CompareTo メソッド

現在のインスタンスを同じ型の別のオブジェクトと比較します。

名前空間: System
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Function CompareTo ( _
    obj As Object _
) As Integer

Visual Basic (使用法)

Dim instance As IComparable
Dim obj As Object
Dim returnValue As Integer

returnValue = instance.CompareTo(obj)

C#

int CompareTo (
    Object obj
)

C++

int CompareTo (
    Object^ obj
)

J#

int CompareTo (
    Object obj
)

JScript

function CompareTo (
    obj : Object
) : int

パラメータ

obj

このインスタンスと比較するオブジェクト。

戻り値
比較対象オブジェクトの相対順序を示す 32 ビット符号付き整数。戻り値の意味は次のとおりです。

値	説明
0 より小さい値	このインスタンスは obj よりも小さくなっています。
0	このインスタンスは obj と等価です。
0 より大きい値	このインスタンスは obj よりも大きくなっています。

例外

例外の種類	条件
ArgumentException	obj の型がこのインスタンスの型と異なります。

解説

このメソッドは定義するだけなので、実際に使用する場合は、特定のクラスや値で実装する必要があります。比較における "より小さい"、"等価"、および "より大きい" の意味は、個別の実装によって異なります。

定義により、すべてのオブジェクトは null 参照 (Visual Basic では Nothing) よりも大きく、また 2 つの null 参照は互いに等しくなります。

obj パラメータは、このインターフェイスを実装するクラスまたは値型と同じ型である必要があります。それ以外の場合は、ArgumentException がスローされます。

実装時の注意 オブジェクト A、B、C について、次の条件が満たされる必要があります。 A.CompareTo(A) は 0 を返す必要があります。 A.CompareTo(B) が 0 を返す場合は、B.CompareTo(A) も 0 を返す必要があります。 A.CompareTo(B) が 0 を返し、B.CompareTo(C) が 0 を返す場合は、A.CompareTo(C) も 0 を返す必要があります。 A.CompareTo(B) が 0 以外の値を返す場合、B.CompareTo(A) は反対の符号の値を返す必要があります。 A.CompareTo(B) が 0 でない値 x を返し、B.CompareTo(C) が x と同じ符号の値 y を返す場合、A.CompareTo(C) は x および y と同じ符号の値を返す必要があります。

呼び出し時の注意 CompareTo メソッドを使用して、クラスのインスタンスの順序を決定します。

使用例

CompareTo を使用して、IComparable を実装している Temperature オブジェクトを別のオブジェクトと比較する方法については、次のコード例を参照してください。

Visual Basic

Public Class Temperature
    Implements IComparable

    Public Overloads Function
 CompareTo(ByVal obj As Object)
 As Integer _
        Implements IComparable.CompareTo

        If TypeOf obj Is
 Temperature Then
            Dim temp As Temperature = CType(obj,
 Temperature)

            Return m_value.CompareTo(temp.m_value)
        End If

        Throw New ArgumentException("object
 is not a Temperature")
    End Function

    ' The value holder
    Protected m_value As Integer

    Public Property Value() As
 Integer
        Get
            Return m_value
        End Get
        Set(ByVal Value As
 Integer)
            m_value = Value
        End Set
    End Property

    Public Property Celsius() As
 Integer
        Get
            Return (m_value - 32) / 2
        End Get
        Set(ByVal Value As
 Integer)
            m_value = Value * 2 + 32
        End Set
    End Property
End Class

C#

public class Temperature : IComparable {
    /// <summary>
    /// IComparable.CompareTo implementation.
    /// </summary>
    public int CompareTo(object obj) {
        if(obj is Temperature) {
            Temperature temp = (Temperature) obj;

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

    // The value holder
    protected int m_value;

    public int Value {
        get {
            return m_value;
        }
        set {
            m_value = value;
        }
    }

    public int Celsius {
        get {
            return (m_value-32)/2;
        }
        set {
            m_value = value*2+32;
        }
    }
}

C++

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->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;
      }
   }
};

J#

public class Temperature implements IComparable
{
    /// <summary>
    /// IComparable.CompareTo implementation.
    /// </summary>
    public int CompareTo(Object obj)
    {
        if (obj instanceof Temperature) {
            Temperature temp = (Temperature)obj;
            return ((Int32)mValue).CompareTo(temp.mValue);
        }
        throw new ArgumentException("object is not a Temperature");
    } //CompareTo

    // The value holder
    protected int mValue;

    /** @property
     */
    public int get_Value()
    {
        return mValue;
    }//get_Value

    /** @property
     */
    public void set_Value(int
 value)
    {
        mValue = value;
    }//set_Value

    /** @property
     */
    public int get_Celsius()
    {
        return (mValue - 32) / 2;
    }//get_Celsius

    /** @property 
     */
    public void set_Celsius(int
 value)
    {
        mValue = value * 2 + 32;
    }//set_Celsius
} //Temperature

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
IComparable インターフェイス
IComparable メンバ
System 名前空間
Object