Tuple<T1,T2,T3,T4,T5,T6>.IComparable.CompareTo(Object) メソッド

定義

現在の Tuple<T1,T2,T3,T4,T5,T6> オブジェクトと指定したオブジェクトを比較して、現在のオブジェクトが、並べ替え順序において、指定したオブジェクトの前後または同じ位置のいずれにあるかを示す整数を返します。Compares the current Tuple<T1,T2,T3,T4,T5,T6> 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);
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

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

戻り値

Int32

並べ替え順序における、このインスタンスと 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.
ゼロZero このインスタンスと 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,T6> オブジェクトではありません。obj is not a Tuple<T1,T2,T3,T4,T5,T6> object.

次の例 Tuple<T1,T2,T3,T4,T5,T6> では、1960 ~ 2000 の米国内の3つの都市の人口データを格納するオブジェクトの配列を作成します。The following example creates an array of Tuple<T1,T2,T3,T4,T5,T6> objects that contain population data for three cities in the United States from 1960 to 2000. 6つのコンポーネントは、都市名の後に、1960 ~ 2000 の10年間隔で市区町村の人口が続きます。The six components consist of the city name followed by the city's population at 10-year intervals from 1960 to 2000. この例では、配列内の各組のコンポーネントを並べ替えられていない順序で表示し、配列を並べ替えてから、メソッドを呼び出して ToString 各組を並べ替えた順序で表示します。The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls the ToString method 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(Object) してください。Note that the example does not directly call the IComparable.CompareTo(Object) method. このメソッドは、 Sort(Array) 配列内の各要素に対してメソッドによって暗黙的に呼び出されます。This method is called implicitly by the Sort(Array) method for each element in the array.

using System;

public class Example
{
   public static void Main()
   {
      // Create array of sextuple with population data for three U.S. 
      // cities, 1960-2000.
      Tuple<string, int, int, int, int, int>[] cities = 
          { Tuple.Create("Los Angeles", 2479015, 2816061, 2966850, 3485398, 3694820),
            Tuple.Create("New York", 7781984, 7894862, 7071639, 7322564, 8008278),  
            Tuple.Create("Chicago", 3550904, 3366957, 3005072, 2783726, 2896016) }; 
      
      // Display array in unsorted order.
      Console.WriteLine("In unsorted order:");
      foreach (var city in cities)
         Console.WriteLine(city.ToString());

      Console.WriteLine();
      
      Array.Sort(cities);
                           
      // Display array in sorted order.
      Console.WriteLine("In sorted order:");
      foreach (var city in cities)
         Console.WriteLine(city.ToString());
   }
}
// The example displays the following output:
//    In unsorted order:
//    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
//    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
//    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
//    
//    In sorted order:
//    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
//    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
//    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
Module Example
   Public Sub Main()
      ' Create array of sextuple with population data for three U.S. 
      ' cities, 1960-2000.
      Dim cities() = 
          { Tuple.Create("Los Angeles", 2479015, 2816061, 2966850, 3485398, 3694820),
            Tuple.Create("New York", 7781984, 7894862, 7071639, 7322564, 8008278),  
            Tuple.Create("Chicago", 3550904, 3366957, 3005072, 2783726, 2896016) } 
      
      ' Display array in unsorted order.
      Console.WriteLine("In unsorted order:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
      Console.WriteLine()
      
      Array.Sort(cities) 
                           
      ' Display array in sorted order.
      Console.WriteLine("In sorted order:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
   End Sub
End Module
' The example displays the following output:
'    In unsorted order:
'    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
'    
'    In sorted order:
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
'    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)

注釈

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

このメソッドは、 IComparable.CompareTo クラスの実装を提供し Tuple<T1,T2,T3,T4,T5,T6> ます。This method provides the IComparable.CompareTo implementation for the Tuple<T1,T2,T3,T4,T5,T6> 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,T6>.Equals(Object) ます。To determine whether two objects are equal, call the Tuple<T1,T2,T3,T4,T5,T6>.Equals(Object) method.

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

適用対象