Tuple<T1>.IComparable.CompareTo(Object) メソッド

定義

名前空間:

System

アセンブリ:

System.Runtime.dll

Source:

Tuple.cs

現在の Tuple<T1> オブジェクトと指定されたオブジェクトを比較し、並べ替え順序において、現在のオブジェクトの位置が指定されたオブジェクトの前になるか、後ろになるか、同じになるかを示す整数を返します。

 virtual int System.IComparable.CompareTo(System::Object ^ obj) = IComparable::CompareTo;

int IComparable.CompareTo (object obj);

abstract member System.IComparable.CompareTo : obj -> int
override this.System.IComparable.CompareTo : obj -> int

Function CompareTo (obj As Object) As Integer Implements IComparable.CompareTo

パラメーター

obj

Object

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

戻り値

Int32

並べ替え順序における、このインスタンスと obj の相対位置を示す符号付き整数値 (次の表を参照)。

値	説明
負の整数	このインスタンスの位置が obj よりも前です。
ゼロ	このインスタンスと obj の位置は、並べ替え順序において同じです。
正の整数	このインスタンスの位置が obj よりも後ろです。

実装

CompareTo(Object)

例外

ArgumentException

obj は Tuple<T1> オブジェクトではありません。

例

次の例では、コンポーネントが値であるシングルトンの配列を Double 作成します。 各タプル コンポーネントの値を並べ替えられていない順序で表示し、配列を並べ替えてから、並べ替えられた順序で値を表示します。 この例では、 メソッドは直接呼び出されないことに Tuple<T1>.IComparable.CompareTo 注意してください。 このメソッドは、配列内の各要素の Sort(Array) メソッドによって暗黙的に呼び出されます。

using System;

class Example
{
   static void Main()
   {
      Tuple<Double>[] values = { Tuple.Create(13.54),
                                 Tuple.Create(Double.NaN),
                                 Tuple.Create(-189.42993),
                                 Tuple.Create(Double.PositiveInfinity),
                                 Tuple.Create(Double.Epsilon),
                                 Tuple.Create(1.934E-17),
                                 Tuple.Create(Double.NegativeInfinity),
                                 Tuple.Create(-0.000000000003588),
                                 null };
      Console.WriteLine("The values in unsorted order:");
      foreach (var value in values)
         if (value != null)
            Console.WriteLine("   {0}", value.Item1);
         else
            Console.WriteLine("   <null>");
      Console.WriteLine();

      Array.Sort(values);

      Console.WriteLine("The values in sorted order:");
      foreach (var value in values)
         if (value != null)
            Console.WriteLine("   {0}", value.Item1);
         else
            Console.WriteLine("   <null>");
   }
}
// The example displays the following output:
//      The values in unsorted order:
//         13.54
//         NaN
//         -189.42993
//         Infinity
//         4.94065645841247E-324
//         1.934E-17
//         -Infinity
//         -3.588E-12
//
//      The values in sorted order:
//         NaN
//         -Infinity
//         -189.42993
//         -3.588E-12
//         4.94065645841247E-324
//         1.934E-17
//         13.54
//         Infinity

open System

let values = 
    [| Tuple.Create 13.54
       Tuple.Create Double.NaN
       Tuple.Create -189.42993
       Tuple.Create Double.PositiveInfinity
       Tuple.Create Double.Epsilon
       Tuple.Create 1.934E-17
       Tuple.Create Double.NegativeInfinity
       Tuple.Create -0.000000000003588
       null |]
printfn "The values in unsorted order:"
for value in values do
    printfn $"   %A{value.Item1}"
printfn ""

Array.Sort values

printfn "The values sorted in descending order:"
for value in values do
    printfn $"   %A{value.Item1}"
// The example displays the following output:
//      The values in unsorted order:
//         13.54
//         NaN
//         -189.42993
//         Infinity
//         4.94065645841247E-324
//         1.934E-17
//         -Infinity
//         -3.588E-12
//
//      The values in sorted order:
//         NaN
//         -Infinity
//         -189.42993
//         -3.588E-12
//         4.94065645841247E-324
//         1.934E-17
//         13.54
//         Infinity

Module Example
    Sub Main()
        Dim values() = { Tuple.Create(13.54),
                         Tuple.Create(Double.NaN),
                         Tuple.Create(-189.42993),
                         Tuple.Create(Double.PositiveInfinity),
                         Tuple.Create(Double.Epsilon),
                         Tuple.Create(1.934E-17),
                         Tuple.Create(Double.NegativeInfinity),
                         Tuple.Create(-0.000000000003588),
                         Nothing}

        Console.WriteLine("The values in unsorted order:")
        For Each value In values
            If value IsNot Nothing Then
                Console.WriteLine("   {0}", value.Item1)
            Else
                Console.WriteLine("   <null>")
            End If
        Next
        Console.WriteLine()

        Array.Sort(values)

        Console.WriteLine("The values in sorted order:")
        For Each value In values
            If value IsNot Nothing Then
                Console.WriteLine("   {0}", value.Item1)
            Else
                Console.WriteLine("   <null>")
            End If
        Next
    End Sub
End Module
' The example displays the following output:
'      The values in unsorted order:
'         13.54
'         NaN
'         -189.42993
'         Infinity
'         4.94065645841247E-324
'         1.934E-17
'         -Infinity
'         -3.588E-12
'
'      The values in sorted order:
'         NaN
'         -Infinity
'         -189.42993
'         -3.588E-12
'         4.94065645841247E-324
'         1.934E-17
'         13.54
'         Infinity

注釈

このメンバーは、明示的なインターフェイス メンバーの実装です。 これは、Tuple<T1> のインスタンスが IComparable インターフェイスにキャストされる場合のみ、使用できます。

このメソッドは、 クラスの IComparable.CompareTo 実装を Tuple<T1> 提供します。 メソッドは直接呼び出すことができますが、コレクションのメンバーを並べ替えるために、 や SortedList.AddなどのArray.Sort(Array)コレクション並べ替えメソッドの既定のオーバーロードによって呼び出されるのが最も一般的です。

注意事項

メソッドは Tuple<T1>.IComparable.CompareTo 、並べ替え操作で使用することを目的としています。 比較の主な目的は、2 つのオブジェクトが等しいかどうかを判断する場合には使用しないでください。 2 つのオブジェクトが等しいかどうかを判断するには、 メソッドを呼び出します Equals 。

メソッドは Tuple<T1>.IComparable.CompareTo 、既定のオブジェクト比較子を使用します。

こちらもご覧ください

• Equals(Object)