Tuple<T1,T2,T3,T4,T5>.IComparable.CompareTo(Object) Tuple<T1,T2,T3,T4,T5>.IComparable.CompareTo(Object) Tuple<T1,T2,T3,T4,T5>.IComparable.CompareTo(Object) Method

定義

現在の Tuple<T1,T2,T3,T4,T5> オブジェクトと指定したオブジェクトを比較して、現在のオブジェクトが、並べ替え順序において、指定したオブジェクトの前後または同じ位置のいずれにあるかを示す整数を返します。Compares the current Tuple<T1,T2,T3,T4,T5> object to a specified object and returns an integer that indicates whether the current object is before, after, or in the same position as the specified object in the sort order.

 virtual int System.IComparable.CompareTo(System::Object ^ obj) = IComparable::CompareTo;
int IComparable.CompareTo (object obj);
Function CompareTo (obj As Object) As Integer Implements IComparable.CompareTo

パラメーター

obj
Object Object Object

現在のインスタンスと比較するオブジェクト。An object to compare with the current instance.

戻り値

並べ替え順序における、このインスタンスと obj の相対位置を示す符号付き整数値 (次の表を参照)。A signed integer that indicates the relative position of this instance and obj in the sort order, as shown in the following table.

[値]Value 説明Description
負の整数A negative integer このインスタンスの位置が obj よりも前です。This instance precedes obj.
0Zero このインスタンスと obj の位置は、並べ替え順序において同じです。This instance and obj have the same position in the sort order.
正の整数A positive integer このインスタンスの位置が obj よりも後ろです。This instance follows obj.

実装

例外

objTuple<T1,T2,T3,T4,T5> オブジェクトではありません。obj is not a Tuple<T1,T2,T3,T4,T5> object.

次の例の配列を作成するTuple<T1,T2,T3,T4,T5>professional のアメリカン フットボールでは、実行の統計を含むオブジェクト。The following example creates an array of Tuple<T1,T2,T3,T4,T5> objects that contain career statistics for running backs in American professional football. プレーヤーの名前、ゲームの数の 5 つのコンポーネントで構成されますプレイする、または試行の数のメートル数の合計が得られるし、タッチダウンの数します。The five components consist of the player's name, the number of games in which he played, the number of carries or attempts, the total number of yards gained, and the number of touchdowns scored. 例では、並べ替え配列内の各タプルのコンポーネントが表示されます、配列を並べ替え、呼び出してToString並べ替えられた順序で各タプルを表示します。The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display each tuple in sorted order. 出力は、最初のコンポーネントは、名前で配列が並べ替えられていることを示しています。The output shows that the array has been sorted by name, which is the first component. 例では、直接呼び出しません注、IComparable.CompareToメソッド。Note that the example does not directly call the IComparable.CompareTo method. このメソッドの呼び出しによって暗黙的に、Sort(Array)配列内の各要素のメソッド。This method is called implicitly by the Sort(Array) method for each element in the array.

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      // Organization of runningBacks 5-tuple:
      //    Component 1: Player name
      //    Component 2: Number of games played
      //    Component 3: Number of attempts (carries)
      //    Component 4: Number of yards gained 
      //    Component 5: Number of touchdowns   
      Tuple<string, int, int, int, int>[] runningBacks =
           { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
             Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
             Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
             Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
             Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) }; 

      // Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
      Console.WriteLine();
      
      // Sort the array
      Array.Sort(runningBacks);
      
      // Display the array in sorted order.
      Console.WriteLine("The values in sorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
   }
}
// The example displays the following output:
//       The values in unsorted order:
//       (Payton, Walter, 190, 3838, 16726, 110)
//       (Sanders, Barry, 153, 3062, 15269, 99)
//       (Brown, Jim, 118, 2359, 12312, 106)
//       (Dickerson, Eric, 144, 2996, 13259, 90)
//       (Faulk, Marshall, 176, 2836, 12279, 100)
//       
//       The values in sorted order:
//       (Brown, Jim, 118, 2359, 12312, 106)
//       (Dickerson, Eric, 144, 2996, 13259, 90)
//       (Faulk, Marshall, 176, 2836, 12279, 100)
//       (Payton, Walter, 190, 3838, 16726, 110)
//       (Sanders, Barry, 153, 3062, 15269, 99)
Imports System.Collections.Generic

Module Example
   Public Sub Main()
      ' Organization of runningBacks 5-tuple:
      '    Component 1: Player name
      '    Component 2: Number of games played
      '    Component 3: Number of attempts (carries)
      '    Component 4: Number of yards gained 
      '    Component 5: Number of touchdowns   
      Dim runningBacks() =
          { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
            Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
            Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
            Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
            Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) } 

      ' Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:")
      For Each runningBack In runningBacks
         Console.WriteLine(runningBack.ToString())
      Next
      Console.WriteLine()
      
      ' Sort the array
      Array.Sort(runningBacks)
      
      ' Display the array in sorted order.
      Console.WriteLine("The values in sorted order:")
      For Each runningBack In runningBacks
         Console.WriteLine(runningBack.ToString())
      Next
   End Sub
End Module
' The example displays the following output:
'       The values in unsorted order:
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Faulk, Marshall, 176, 2836, 12279, 100)
'       
'       The values in sorted order:
'       (Brown, Jim, 118, 2359, 12312, 106)
'       (Dickerson, Eric, 144, 2996, 13259, 90)
'       (Faulk, Marshall, 176, 2836, 12279, 100)
'       (Payton, Walter, 190, 3838, 16726, 110)
'       (Sanders, Barry, 153, 3062, 15269, 99)

注釈

このメンバーは、明示的なインターフェイス メンバーの実装です。This member is an explicit interface member implementation. これは、Tuple<T1,T2,T3,T4,T5> のインスタンスが IComparable インターフェイスにキャストされる場合のみ、使用できます。It can be used only when the Tuple<T1,T2,T3,T4,T5> instance is cast to an IComparable interface.

この方法では、IComparable.CompareToの実装、Tuple<T1,T2,T3,T4,T5>クラス。This method provides the IComparable.CompareTo implementation for the Tuple<T1,T2,T3,T4,T5> class. コレクションの並べ替えの既定のオーバー ロードによって最もよく呼び出されますが、メソッドを直接呼び出すことができます、メソッドなどArray.Sort(Array)SortedList.Addコレクションのメンバーの順序付けをします。Although the method can be called directly, it is most commonly called by the default overloads of collection-sorting methods, such as Array.Sort(Array) and SortedList.Add, to order the members of a collection.

注意事項

IComparable.CompareTo並べ替え操作で使用するためのメソッドです。The IComparable.CompareTo method is intended for use in sorting operations. また、比較の主な目的は、2 つのオブジェクトが等しいかどうかを判断するときにない使用する必要があります。It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. 2 つのオブジェクトが等しいかどうかを確認するのには、呼び出し、Tuple<T1,T2,T3,T4,T5>.Equals(Object)メソッド。To determine whether two objects are equal, call the Tuple<T1,T2,T3,T4,T5>.Equals(Object) method.

IComparable.CompareTo(Object)メソッドでは、既定のオブジェクトの比較子を使用して、各コンポーネントを比較します。The IComparable.CompareTo(Object) method uses the default object comparer to compare each component.

適用対象

こちらもご覧ください