Tuple<T1,T2,T3,T4>.IStructuralComparable.CompareTo(Object, IComparer) 方法

定义

使用指定的比较器将当前的 Tuple<T1,T2,T3,T4> 对象与指定对象进行比较,并返回一个整数,该整数指示当前对象在排序顺序中的位置是在指定对象之前、之后还是与其相同。Compares the current Tuple<T1,T2,T3,T4> object to a specified object by using a specified comparer 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.Collections.IStructuralComparable.CompareTo(System::Object ^ other, System::Collections::IComparer ^ comparer) = System::Collections::IStructuralComparable::CompareTo;
int IStructuralComparable.CompareTo (object other, System.Collections.IComparer comparer);
abstract member System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int
override this.System.Collections.IStructuralComparable.CompareTo : obj * System.Collections.IComparer -> int
Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

参数

other
Object

要与当前实例进行比较的对象。An object to compare with the current instance.

comparer
IComparer

提供用于比较的自定义规则的对象。An object that provides custom rules for comparison.

返回

Int32

一个带符号整数,指示此实例和 other 在排序顺序中的相对位置,如下表所示。A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

Value 说明Description
负整数A negative integer 此实例位于 other 之前。This instance precedes other.
Zero 此实例在排序顺序中的位置与 other 相同。This instance and other have the same position in the sort order.
正整数A positive integer 此实例位于 other 之后。This instance follows other.

实现

例外

other 不是 Tuple<T1,T2,T3,T4> 对象。other is not a Tuple<T1,T2,T3,T4> object.

示例

下面的示例创建一个对象数组 Tuple<T1,T2,T3,T4> ,其中包含有关棒球 pitchers 的统计数据。The following example creates an array of Tuple<T1,T2,T3,T4> objects that contain statistical data about baseball pitchers. 数据项包含罐状指针的名称、节的数量、罐状指针的挣值 (平均每个游戏使用的每个运行数) ,以及罐状指针的命中次数。The data items include the name of the pitcher, the number of innings pitched, the pitcher's earned run average (the average number of runs a pitcher allows per game), and the number of hits the pitcher has given up. 该示例以未排序的顺序显示数组中每个元组的组件,对数组进行排序,然后调用 ToString 以按排序顺序显示每个元组的值。The example displays the component of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display the value of each tuple in sorted order. 若要对数组进行排序,此示例定义了一个泛型 PitcherComparer 类,该类实现 IComparer 接口,并按 Tuple<T1,T2,T3,T4> 其第三个组件的值以升序对对象进行排序, (获得的运行平均) 而不是其第一个组件。To sort the array, the example defines a generic PitcherComparer class that implements the IComparer interface and sorts the Tuple<T1,T2,T3,T4> objects in ascending order by the value of their third component (the earned run average) rather than their first component. 请注意,该示例不会直接调用 IStructuralComparable.CompareTo(Object, IComparer) 方法。Note that the example does not directly call the IStructuralComparable.CompareTo(Object, IComparer) method. 此方法由 Array.Sort(Array, IComparer) 方法为数组中的每个元素隐式调用。This method is called implicitly by the Array.Sort(Array, IComparer) method for each element in the array.

using System;
using System.Collections;
using System.Collections.Generic;

public class PitcherComparer<T1, T2, T3, T4> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2, T3, T4> tX = x as Tuple<T1, T2, T3, T4>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2, T3, T4> tY = y as Tuple<T1, T2, T3, T4>;
         return Comparer<T3>.Default.Compare(tX.Item3, tY.Item3);             
      }
   }
}

public class Example
{
   public static void Main()
   {
      Tuple<string, double, double, int>[] pitchers = 
                    { Tuple.Create("McHale, Joe", 240.1, 3.60, 221),
                      Tuple.Create("Paul, Dave", 233.1, 3.24, 231), 
                      Tuple.Create("Williams, Mike", 193.2, 4.00, 183),
                      Tuple.Create("Blair, Jack", 168.1, 3.48, 146), 
                      Tuple.Create("Henry, Walt", 140.1, 1.92, 96),
                      Tuple.Create("Lee, Adam", 137.2, 2.94, 109),
                      Tuple.Create("Rohr, Don", 101.0, 3.74, 110) };

      Console.WriteLine("The values in unsorted order:");
      foreach (var pitcher in pitchers)
         Console.WriteLine(pitcher.ToString());

      Console.WriteLine();

      Array.Sort(pitchers, new PitcherComparer<string, double, double, int>());

      Console.WriteLine("The values sorted by earned run average (component 3):");
      foreach (var pitcher in pitchers)
         Console.WriteLine(pitcher.ToString());
   }
}
// The example displays the following output;
//       The values in unsorted order:
//       (McHale, Joe, 240.1, 3.6, 221)
//       (Paul, Dave, 233.1, 3.24, 231)
//       (Williams, Mike, 193.2, 4, 183)
//       (Blair, Jack, 168.1, 3.48, 146)
//       (Henry, Walt, 140.1, 1.92, 96)
//       (Lee, Adam, 137.2, 2.94, 109)
//       (Rohr, Don, 101, 3.74, 110)
//       
//       The values sorted by earned run average (component 3):
//       (Henry, Walt, 140.1, 1.92, 96)
//       (Lee, Adam, 137.2, 2.94, 109)
//       (Rohr, Don, 101, 3.74, 110)
//       (Blair, Jack, 168.1, 3.48, 146)
//       (McHale, Joe, 240.1, 3.6, 221)
//       (Paul, Dave, 233.1, 3.24, 231)
//       (Williams, Mike, 193.2, 4, 183)
Imports System.Collections
Imports System.Collections.Generic

Public Class PitcherComparer(Of T1, T2, T3, T4) : Implements IComparer
   Public Function Compare(x As Object, y As Object) As Integer _
                   Implements IComparer.Compare
      Dim tX As Tuple(Of T1, T2, T3) = TryCast(x, Tuple(Of T1, T2, T3))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY As Tuple(Of T1, T2, T3) = DirectCast(y, Tuple(Of T1, T2, T3))
         Return Comparer(Of T3).Default.Compare(tx.Item3, tY.Item3)             
      End If
   End Function
End Class

Module Example
   Public Sub Main()
      Dim pitchers() = 
                { Tuple.Create("McHale, Joe", 240.1, 3.60, 221),
                  Tuple.Create("Paul, Dave", 233.1, 3.24, 231), 
                  Tuple.Create("Williams, Mike", 193.2, 4.00, 183),
                  Tuple.Create("Blair, Jack", 168.1, 3.48, 146), 
                  Tuple.Create("Henry, Walt", 140.1, 1.92, 96),
                  Tuple.Create("Lee, Adam", 137.2, 2.94, 109),
                  Tuple.Create("Rohr, Don", 101.0, 3.74, 110) }

      Console.WriteLine("The values in unsorted order:")
      For Each pitcher In pitchers
         Console.WriteLine(pitcher.ToString())
      Next
      Console.WriteLine()

      Array.Sort(pitchers, New PitcherComparer(Of String, Double, Double, Integer)())

      Console.WriteLine("The values sorted by earned run average (component 3):")
      For Each pitcher In pitchers
         Console.WriteLine(pitcher.ToString())
      Next
   End Sub
End Module
' The example displays the following output;
'       The values in unsorted order:
'       (McHale, Joe, 240.1, 3.6, 221)
'       (Paul, Dave, 233.1, 3.24, 231)
'       (Williams, Mike, 193.2, 4, 183)
'       (Blair, Jack, 168.1, 3.48, 146)
'       (Henry, Walt, 140.1, 1.92, 96)
'       (Lee, Adam, 137.2, 2.94, 109)
'       (Rohr, Don, 101, 3.74, 110)
'       
'       The values sorted by earned run average (component 3):
'       (Henry, Walt, 140.1, 1.92, 96)
'       (Lee, Adam, 137.2, 2.94, 109)
'       (Rohr, Don, 101, 3.74, 110)
'       (Blair, Jack, 168.1, 3.48, 146)
'       (McHale, Joe, 240.1, 3.6, 221)
'       (Paul, Dave, 233.1, 3.24, 231)
'       (Williams, Mike, 193.2, 4, 183)

注解

此成员是显式接口成员的实现。This member is an explicit interface member implementation. 它只能在 Tuple<T1,T2,T3,T4> 实例被强制转换为 IStructuralComparable 接口时使用。It can be used only when the Tuple<T1,T2,T3,T4> instance is cast to an IStructuralComparable interface.

尽管可以直接调用此方法,但它最常见的方法是包含参数的集合排序方法, IComparer 以对集合的成员进行排序。Although this method can be called directly, it is most commonly called by collection sorting methods that include IComparer parameters to order the members of a collection. 例如,它由 Array.Sort(Array, IComparer) 方法和 Add SortedList 使用构造函数实例化的对象的方法调用 SortedList.SortedList(IComparer)For example, it is called by the Array.Sort(Array, IComparer) method and the Add method of a SortedList object that is instantiated by using the SortedList.SortedList(IComparer) constructor.

注意

IStructuralComparable.CompareTo(Object, IComparer)方法旨在用于排序操作。The IStructuralComparable.CompareTo(Object, IComparer) method is intended for use in sorting operations. 如果比较的主要目的是确定两个对象是否相等,则不应使用此方法。It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. 若要确定两个对象是否相等,请调用 IStructuralEquatable.Equals(Object, IEqualityComparer) 方法。To determine whether two objects are equal, call the IStructuralEquatable.Equals(Object, IEqualityComparer) method.

适用于