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

Definice

Porovná aktuální Tuple<T1,T2> objekt se zadaným objektem pomocí zadané porovnávací metody a vrátí celé číslo, které označuje, zda je aktuální objekt před, za nebo na stejné pozici jako zadaný objekt v pořadí řazení.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);
Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

Parametry

other
Object

Objekt k porovnání s aktuální instancí.An object to compare with the current instance.

comparer
IComparer

Objekt, který poskytuje vlastní pravidla pro porovnání.An object that provides custom rules for comparison.

Návraty

Celé číslo se znaménkem, které označuje relativní pozici této instance other a v pořadí řazení, jak je znázorněno v následující tabulce.A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

ValueValue PopisDescription
Záporné celé čísloA negative integer Tato instance předchází other.This instance precedes other.
NulaZero Tato instance a other má stejné umístění v pořadí řazení.This instance and other have the same position in the sort order.
Kladné celé čísloA positive integer Tato instance následuje otherpo.This instance follows other.

Implementuje

Výjimky

otherTuple<T1,T2> není objekt.other is not a Tuple<T1,T2> object.

Příklady

Následující příklad vytvoří pole Tuple<T1,T2> objektů, které se skládají z názvu studenta a skóre testu.The following example creates an array of Tuple<T1,T2> objects that consist of a student's name and test score. Zobrazuje komponentu každé řazené kolekce členů v poli v neseřazeném pořadí, seřadí pole a potom volá ToString k zobrazení hodnoty každé řazené kolekce členů v seřazeném pořadí.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. Pro seřazení pole je v příkladu definována obecná ScoreComparer třída, která IComparer implementuje rozhraní a seřadí Tuple<T1,T2> objekty ve vzestupném pořadí podle hodnoty jejich druhé komponenty namísto jejich první součásti.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. Všimněte si, že tento příklad přímo nevolá IStructuralComparable.CompareTo metodu.Note that the example does not directly call the IStructuralComparable.CompareTo method. Tato metoda je volána implicitně Array.Sort(Array, IComparer) metodou pro každý prvek v poli.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)

Poznámky

Tento člen je explicitní implementace členu rozhraní.This member is an explicit interface member implementation. Dá se použít jenom v případě, Tuple<T1,T2> že je instance přetypování IStructuralComparable na rozhraní.It can be used only when the Tuple<T1,T2> instance is cast to an IStructuralComparable interface.

Přestože lze tuto metodu volat přímo, je nejčastěji volána metodami řazení kolekce, které obsahují IComparer parametry pro seřazení členů kolekce.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. Například je volána Array.Sort(Array, IComparer) metodou Add a SortedList metodouSortedList.SortedList(IComparer) objektu, jehož instance je vytvořena pomocí konstruktoru.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.

Upozornění

IStructuralComparable.CompareTo Metoda je určena pro použití při řazení operací.The IStructuralComparable.CompareTo method is intended for use in sorting operations. Není vhodné jej používat, pokud je primárním účelem porovnání zjištění, zda se dva objekty rovnají.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Chcete-li zjistit, zda jsou dva objekty stejné IStructuralEquatable.Equals , zavolejte metodu.To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

Platí pro

Viz také