Tuple<T1,T2>.IStructuralComparable.CompareTo(Object, IComparer) Metoda

Definicja

Porównuje bieżący Tuple<T1,T2> obiekt z określonym obiektem przy użyciu określonej funkcji porównującej i zwraca liczbę całkowitą, która wskazuje, czy bieżący obiekt jest przed, po lub w tym samym położeniu, co określony obiekt w kolejności sortowania.Compares the current Tuple<T1,T2> 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

Parametry

other
Object

Obiekt, który ma zostać porównany z bieżącym wystąpieniem.An object to compare with the current instance.

comparer
IComparer

Obiekt dostarczający niestandardowe reguły na potrzeby porównania.An object that provides custom rules for comparison.

Zwraca

Int32

Liczba całkowita ze znakiem, która wskazuje względną pozycję tego wystąpienia i other w kolejności sortowania, jak pokazano w poniższej tabeli.A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

WartośćValue OpisDescription
Ujemna liczba całkowitaA negative integer To wystąpienie poprzedza other .This instance precedes other.
ZeroZero To wystąpienie i other ma takie same położenie w kolejności sortowania.This instance and other have the same position in the sort order.
Dodatnia liczba całkowitaA positive integer To wystąpienie jest następujące other .This instance follows other.

Implementuje

Wyjątki

other nie jest Tuple<T1,T2> obiektem.other is not a Tuple<T1,T2> object.

Przykłady

Poniższy przykład tworzy tablicę Tuple<T1,T2> obiektów, które składają się z nazwy studenta i oceny testu.The following example creates an array of Tuple<T1,T2> objects that consist of a student's name and test score. Wyświetla składnik każdej krotki w tablicy w kolejności niesortowanej, Sortuje tablicę, a następnie wywołuje w ToString celu wyświetlenia wartości poszczególnych krotek w sortowanej kolejności.It 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. Aby posortować tablicę, w przykładzie zdefiniowano ScoreComparer klasę generyczną implementującą IComparer interfejs i sortuje Tuple<T1,T2> obiekty w kolejności rosnącej według wartości drugiego składnika, a nie pierwszego składnika.To sort the array, the example defines a generic ScoreComparer class that implements the IComparer interface and sorts the Tuple<T1,T2> objects in ascending order by the value of their second component rather than their first component. Należy zauważyć, że przykład nie wywołuje bezpośrednio IStructuralComparable.CompareTo metody.Note that the example does not directly call the IStructuralComparable.CompareTo method. Ta metoda jest wywoływana niejawnie przez Array.Sort(Array, IComparer) metodę dla każdego elementu w tablicy.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 ScoreComparer<T1, T2> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2> tX = x as Tuple<T1,T2>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2> tY = y as Tuple<T1, T2>;
         return Comparer<T2>.Default.Compare(tX.Item2, tY.Item2);             
      }
   }
}

public class Example
{
   public static void Main()
   {
      Tuple<string, Nullable<int>>[] scores = 
                    { new Tuple<string, Nullable<int>>("Jack", 78),
                      new Tuple<string, Nullable<int>>("Abbey", 92), 
                      new Tuple<string, Nullable<int>>("Dave", 88),
                      new Tuple<string, Nullable<int>>("Sam", 91), 
                      new Tuple<string, Nullable<int>>("Ed", null),
                      new Tuple<string, Nullable<int>>("Penelope", 82),
                      new Tuple<string, Nullable<int>>("Linda", 99),
                      new Tuple<string, Nullable<int>>("Judith", 84) };

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

      Console.WriteLine();

      Array.Sort(scores, new ScoreComparer<string, Nullable<int>>());

      Console.WriteLine("The values in sorted order:");
      foreach (var score in scores)
         Console.WriteLine(score.ToString());
   }
}
// The example displays the following output;
//       The values in unsorted order:
//       (Jack, 78)
//       (Abbey, 92)
//       (Dave, 88)
//       (Sam, 91)
//       (Ed, )
//       (Penelope, 82)
//       (Linda, 99)
//       (Judith, 84)
//       
//       The values in sorted order:
//       (Ed, )
//       (Jack, 78)
//       (Penelope, 82)
//       (Judith, 84)
//       (Dave, 88)
//       (Sam, 91)
//       (Abbey, 92)
//       (Linda, 99)
Imports System.Collections
Imports System.Collections.Generic

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

Module Example
   Public Sub Main()
      Dim scores() As Tuple(Of String, Nullable(Of Integer)) = 
                      { New Tuple(Of String, Nullable(Of Integer))("Jack", 78),
                        New Tuple(Of String, Nullable(Of Integer))("Abbey", 92), 
                        New Tuple(Of String, Nullable(Of Integer))("Dave", 88),
                        New Tuple(Of String, Nullable(Of Integer))("Sam", 91), 
                        New Tuple(Of String, Nullable(Of Integer))("Ed", Nothing),
                        New Tuple(Of String, Nullable(Of Integer))("Penelope", 82),
                        New Tuple(Of String, Nullable(Of Integer))("Linda", 99),
                        New Tuple(Of String, Nullable(Of Integer))("Judith", 84) }

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

      Array.Sort(scores, New ScoreComparer(Of String, Nullable(Of Integer))())

      Console.WriteLine("The values in sorted order:")
      For Each score In scores
         Console.WriteLine(score.ToString())
      Next
   End Sub
End Module
' The example displays the following output;
'       The values in unsorted order:
'       (Jack, 78)
'       (Abbey, 92)
'       (Dave, 88)
'       (Sam, 91)
'       (Ed, )
'       (Penelope, 82)
'       (Linda, 99)
'       (Judith, 84)
'       
'       The values in sorted order:
'       (Ed, )
'       (Jack, 78)
'       (Penelope, 82)
'       (Judith, 84)
'       (Dave, 88)
'       (Sam, 91)
'       (Abbey, 92)
'       (Linda, 99)

Uwagi

Ten element jest jawną implementacją członków.This member is an explicit interface member implementation. Może być używana tylko wtedy, gdy Tuple<T1,T2> wystąpienie jest rzutowane do IStructuralComparable interfejsu.It can be used only when the Tuple<T1,T2> instance is cast to an IStructuralComparable interface.

Chociaż ta metoda może być wywoływana bezpośrednio, jest najczęściej wywoływana przez metody sortowania kolekcji, które obejmują IComparer Parametry w celu uporządkowania elementów członkowskich kolekcji.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. Na przykład jest wywoływana przez Array.Sort(Array, IComparer) metodę i Add metodę SortedList obiektu, którego wystąpienie jest tworzone przy użyciu SortedList.SortedList(IComparer) konstruktora.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.

Przestroga

IStructuralComparable.CompareToMetoda jest przeznaczona do użycia podczas sortowania operacji.The IStructuralComparable.CompareTo method is intended for use in sorting operations. Nie należy jej używać, gdy głównym celem porównania jest ustalenie, czy dwa obiekty są sobie równe.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Aby określić, czy dwa obiekty są równe, wywołaj IStructuralEquatable.Equals metodę.To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

Dotyczy

Zobacz też