IComparable<T> IComparable<T> IComparable<T> IComparable<T> Interface

Definition

インスタンスの並べ替えなどを目的とし、型固有の比較メソッドを作成するために値型またはクラスで実装する、汎用の比較メソッドを定義します。 Defines a generalized comparison method that a value type or class implements to create a type-specific comparison method for ordering or sorting its instances.

generic <typename T>
public interface class IComparable
public interface IComparable<in T>
type IComparable<'T> = interface
Public Interface IComparable(Of In T)

Type Parameters

T

比較するオブジェクトの型。 The type of object to compare.

Derived

Examples

次のコード例の実装を示しています。IComparable<T>簡単なTemperatureオブジェクト。The following code example illustrates the implementation of IComparable<T> for a simple Temperature object. 例は、作成、SortedList<TKey,TValue>と文字列のコレクションTemperatureオブジェクトのキーと温度と文字列のペアを複数をシーケンスからリストに追加します。The example creates a SortedList<TKey,TValue> collection of strings with Temperature object keys, and adds several pairs of temperatures and strings to the list out of sequence. 呼び出しで、Addメソッド、SortedList<TKey,TValue>コレクションは、IComparable<T>の温度を昇順に表示される、一覧のエントリの並べ替えを実装します。In the call to the Add method, the SortedList<TKey,TValue> collection uses the IComparable<T> implementation to sort the list entries, which are then displayed in order of increasing temperature.

#using <System.dll>

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

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

protected:
   // The underlying temperature value.
   Double m_value;

public:
   // Implement the generic CompareTo method with the Temperature class 
   // as the Type parameter. 
   virtual Int32 CompareTo( Temperature^ other ) {
   
      // If other is not a valid object reference, this instance 
      // is greater.
      if (other == nullptr) return 1;
      
      // The temperature comparison depends on the comparison of the
      // the underlying Double values. 
      return m_value.CompareTo( other->m_value );
   }

       // Define the is greater than operator.
    bool operator>=  (Temperature^ other)
    {
       return CompareTo(other) == 1;
    }
    
    // Define the is less than operator.
    bool operator<  (Temperature^ other)
    {
       return CompareTo(other) == -1;
    }
    
       // Define the is greater than or equal to operator.
    bool operator>  (Temperature^ other)
    {
       return CompareTo(other) >= 0;
    }
    
    // Define the is less than or equal to operator.
    bool operator<=  (Temperature^ other)
    {
       return CompareTo(other) <= 0;
    }

   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 kelvins) {
      this->Kelvin = kelvins;
   }
};

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);
   }
}
/* The example displays 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.
*/
using System;
using System.Collections.Generic;

public class Temperature : IComparable<Temperature>
{
    // Implement the generic CompareTo method with the Temperature 
    // class as the Type parameter. 
    //
    public int CompareTo(Temperature other)
    {
        // If other is not a valid object reference, this instance is greater.
        if (other == null) return 1;
        
        // The temperature comparison depends on the comparison of 
        // the underlying Double values. 
        return m_value.CompareTo(other.m_value);
    }

    // Define the is greater than operator.
    public static bool operator >  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) == 1;
    }
    
    // Define the is less than operator.
    public static bool operator <  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) == -1;
    }

    // Define the is greater than or equal to operator.
    public static bool operator >=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) >= 0;
    }
    
    // Define the is less than or equal to operator.
    public static bool operator <=  (Temperature operand1, Temperature operand2)
    {
       return operand1.CompareTo(operand2) <= 0;
    }

    // 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 kelvins)
    {
        this.Kelvin = kelvins;
    }
}

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 example displays 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.
*/
Imports System.Collections.Generic

Public Class Temperature
    Implements IComparable(Of Temperature)

    ' Implement the generic CompareTo method with the Temperature class 
    ' as the type parameter. 
    '
    Public Overloads Function CompareTo(ByVal other As Temperature) As Integer _
        Implements IComparable(Of Temperature).CompareTo

        ' If other is not a valid object reference, this instance is greater.
        If other Is Nothing Then Return 1
        
        ' The temperature comparison depends on the comparison of the
        ' the underlying Double values. 
        Return m_value.CompareTo(other.m_value)
    End Function
    
    ' Define the is greater than operator.
    Public Shared Operator >  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) = 1
    End Operator
    
    ' Define the is less than operator.
    Public Shared Operator <  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) = -1
    End Operator

    ' Define the is greater than or equal to operator.
    Public Shared Operator >=  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) >= 0
    End Operator
    
    ' Define the is less than operator.
    Public Shared Operator <=  (operand1 As Temperature, operand2 As Temperature) As Boolean
       Return operand1.CompareTo(operand2) <= 0
    End Operator

    ' 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 kelvins As Double)
        Me.Kelvin = kelvins 
    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

' The example displays 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.
'

Remarks

このインターフェイスは値を持つを順序付けられたか、並べ替えの種類によって実装され、ジェネリック コレクション オブジェクトのメンバーを順序付けに厳密に型指定された比較メソッドを提供します。This interface is implemented by types whose values can be ordered or sorted and provides a strongly typed comparison method for ordering members of a generic collection object. たとえば、1 つの数値が 2 番目の数値より大きくすることができ、1 つの文字列は、前に、別のアルファベット順で表示できます。For example, one number can be larger than a second number, and one string can appear in alphabetical order before another. 実装する型が 1 つのメソッドを定義することが必要ですがCompareTo(T)、する前で、並べ替え順序において、現在のインスタンスの位置をかどうかがその後、または同じ型の 2 番目のオブジェクトと同じすることを示します。It requires that implementing types define a single method, CompareTo(T), that indicates whether the position of the current instance in the sort order is before, after, or the same as a second object of the same type. 通常、メソッドは、開発者のコードから直接は呼び出されません。Typically, the method is not called directly from developer code. 代わりに、自動的に呼び出されますメソッドによってなどList<T>.Sort()Addします。Instead, it is called automatically by methods such as List<T>.Sort() and Add.

通常、型を提供する、IComparable<T>実装はまた、実装、IEquatable<T>インターフェイス。Typically, types that provide an IComparable<T> implementation also implement the IEquatable<T> interface. IEquatable<T>インターフェイスを定義、Equalsメソッドを実装する型のインスタンスが等しいかどうかを判断します。The IEquatable<T> interface defines the Equals method, which determines the equality of instances of the implementing type.

実装、CompareTo(T)メソッドが返す必要があります、Int32次の表に示すようを持つ 3 つの値のいずれか。The implementation of the CompareTo(T) method must return an Int32 that has one of three values, as shown in the following table.

[値]Value 説明Meaning
0 より小さい値Less than zero このオブジェクトで指定されたオブジェクトの前に、CompareTo並べ替え順序においてメソッド。This object precedes the object specified by the CompareTo method in the sort order.
0Zero この現在のインスタンスがで指定されたオブジェクトと、並べ替え順序において同じ位置で発生する、CompareToメソッドの引数。This current instance occurs in the same position in the sort order as the object specified by the CompareTo method argument.
0 より大きい値Greater than zero この現在のインスタンスで指定されたオブジェクトに依存して、CompareTo並べ替え順序においてメソッドの引数。This current instance follows the object specified by the CompareTo method argument in the sort order.

すべての数値型 (などInt32Double) 実装IComparable<T>と同様、 StringChar、およびDateTimeします。All numeric types (such as Int32 and Double) implement IComparable<T>, as do String, Char, and DateTime. カスタム型がの独自の実装を提供する必要がありますもIComparable<T>オブジェクトのインスタンスを並べ替える、または並べ替えを有効にします。Custom types should also provide their own implementation of IComparable<T> to enable object instances to be ordered or sorted.

Notes to Implementers

型パラメーターを置き換える、IComparable<T>がこのインターフェイスを実装している型を持つインターフェイスです。実装する場合IComparable<T>、オーバー ロードする必要があります、 op_GreaterThanop_GreaterThanOrEqualop_LessThan、およびop_LessThanOrEqual演算子と一致する値を返すCompareTo(T)します。さらに、実行する必要もIEquatable<T>します。参照してください、IEquatable<T>完全な情報の記事。

Replace the type parameter of the IComparable<T> interface with the type that is implementing this interface. If you implement IComparable<T>, you should overload the op_GreaterThan, op_GreaterThanOrEqual, op_LessThan, and op_LessThanOrEqual operators to return values that are consistent with CompareTo(T). In addition, you should also implement IEquatable<T>. See the IEquatable<T> article for complete information.

Methods

CompareTo(T) CompareTo(T) CompareTo(T) CompareTo(T)

現在のインスタンスを同じ型の別のオブジェクトと比較し、現在のインスタンスの並べ替え順序での位置が、比較対象のオブジェクトと比べて前か、後か、または同じかを示す整数を返します。 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.

Applies to

See Also