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

Definition

Vergleicht das aktuelle Tuple<T1,T2,T3>-Objekt anhand eines angegebenen Vergleichs mit einem angegebenen Objekt und gibt eine ganze Zahl zurück, die angibt, ob sich das aktuelle Objekt in der Sortierreihenfolge vor dem angegebenen Objekt, dahinter oder an derselben Position befindet.Compares the current Tuple<T1,T2,T3> 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

Parameters

other
Object

Ein Objekt, das mit der aktuellen Instanz verglichen werden soll.An object to compare with the current instance.

comparer
IComparer

Ein Objekt, das benutzerdefinierte Regeln für Vergleiche bereitstellt.An object that provides custom rules for comparison.

Returns

Int32

Eine ganze Zahl mit Vorzeichen, die die relative Position dieser Instanz und von other in der Sortierreihenfolge angibt, wie in der folgenden Tabelle veranschaulicht.A signed integer that indicates the relative position of this instance and other in the sort order, as shown in the following table.

WertValue BeschreibungDescription
Eine negative ganze ZahlA negative integer Diese Instanz geht other voran.This instance precedes other.
NullZero Diese Instanz und other befinden sich in der Sortierreihenfolge an der gleichen Position.This instance and other have the same position in the sort order.
Positive GanzzahlA positive integer Diese Instanz folgt other.This instance follows other.

Implements

Exceptions

other ist kein Tuple<T1,T2,T3>-Objekt.other is not a Tuple<T1,T2,T3> object.

Examples

Im folgenden Beispiel wird ein Array von Tuple<T1,T2,T3> Objekten erstellt, die aus dem Namen des Studenten, dem Mittelwert Test und der Anzahl der Tests bestehen.The following example creates an array of Tuple<T1,T2,T3> objects that consist of a student's name, mean test score, and number of tests. Sie zeigt die Komponente der einzelnen Tupel im Array in unsortierter Reihenfolge an, sortiert das Array und ruft dann ToString auf, um den Wert jedes Tupels in sortierter Reihenfolge anzuzeigen.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. Zum Sortieren des Arrays definiert das Beispiel eine generische ScoreComparer Klasse, die die IComparer-Schnittstelle implementiert und die Tuple<T1,T2,T3> Objekte in aufsteigender Reihenfolge nach dem Wert der zweiten Komponente anstatt ihrer ersten Komponente sortiert.To sort the array, the example defines a generic ScoreComparer class that implements the IComparer interface and sorts the Tuple<T1,T2,T3> objects in ascending order by the value of their second component rather than their first component. Beachten Sie, dass das Beispiel den Tuple<T1,T2,T3>.IStructuralComparable.CompareTo-Methode nicht direkt aufruft.Note that the example does not directly call the Tuple<T1,T2,T3>.IStructuralComparable.CompareTo method. Diese Methode wird implizit von der Array.Sort(Array, IComparer)-Methode für jedes Element im Array aufgerufen.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, T3> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2, T3> tX = x as Tuple<T1,T2, T3>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2, T3> tY = y as Tuple<T1, T2, T3>;
         return Comparer<T2>.Default.Compare(tX.Item2, tY.Item2);             
      }
   }
}

public class Example
{
   public static void Main()
   {
      Tuple<string, double, int>[] scores = 
                { Tuple.Create("Jack", 78.8, 8),
                  Tuple.Create("Abbey", 92.1, 9), 
                  Tuple.Create("Dave", 88.3, 9),
                  Tuple.Create("Sam", 91.7, 8), 
                  Tuple.Create("Ed", 71.2, 5),
                  Tuple.Create("Penelope", 82.9, 8),
                  Tuple.Create("Linda", 99.0, 9),
                  Tuple.Create("Judith", 84.3, 9) };

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

      Console.WriteLine();

      Array.Sort(scores, new ScoreComparer<string, double, 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.8, 8)
//       (Abbey, 92.1, 9)
//       (Dave, 88.3, 9)
//       (Sam, 91.7, 8)
//       (Ed, 71.2, 5)
//       (Penelope, 82.9, 8)
//       (Linda, 99, 9)
//       (Judith, 84.3, 9)
//       
//       The values in sorted order:
//       (Ed, 71.2, 5)
//       (Jack, 78.8, 8)
//       (Penelope, 82.9, 8)
//       (Judith, 84.3, 9)
//       (Dave, 88.3, 9)
//       (Sam, 91.7, 8)
//       (Abbey, 92.1, 9)
//       (Linda, 99, 9)
Imports System.Collections
Imports System.Collections.Generic

Public Class ScoreComparer(Of T1, T2, T3) : 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 T2).Default.Compare(tx.Item2, tY.Item2)             
      End If
   End Function
End Class

Module Example
   Public Sub Main()
      Dim scores() = 
                 { Tuple.Create("Jack", 78.8, 8),
                   Tuple.Create("Abbey", 92.1, 9), 
                   Tuple.Create("Dave", 88.3, 9),
                   Tuple.Create("Sam", 91.7, 8), 
                   Tuple.Create("Ed", 71.2, 5),
                   Tuple.Create("Penelope", 82.9, 8),
                   Tuple.Create("Linda", 99.0, 9),
                   Tuple.Create("Judith", 84.3, 9) }

      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, Double, 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.8, 8)
'       (Abbey, 92.1, 9)
'       (Dave, 88.3, 9)
'       (Sam, 91.7, 8)
'       (Ed, 71.2, 5)
'       (Penelope, 82.9, 8)
'       (Linda, 99, 9)
'       (Judith, 84.3, 9)
'       
'       The values in sorted order:
'       (Ed, 71.2, 5)
'       (Jack, 78.8, 8)
'       (Penelope, 82.9, 8)
'       (Judith, 84.3, 9)
'       (Dave, 88.3, 9)
'       (Sam, 91.7, 8)
'       (Abbey, 92.1, 9)
'       (Linda, 99, 9)

Remarks

Dieser Member ist eine explizite Schnittstellen-Memberimplementierung.This member is an explicit interface member implementation. Er kann nur verwendet werden, wenn die Tuple<T1,T2,T3>-Instanz in eine IStructuralComparable-Schnittstelle umgewandelt wird.It can be used only when the Tuple<T1,T2,T3> instance is cast to an IStructuralComparable interface.

Obwohl diese Methode direkt aufgerufen werden kann, wird Sie am häufigsten von Auflistungs Sortiermethoden aufgerufen, die IComparer-Parameter enthalten, um die Elemente einer Auflistung zu sortieren.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. Beispielsweise wird Sie durch die Array.Sort(Array, IComparer)-Methode und die Add-Methode eines SortedList-Objekts aufgerufen, das mit dem SortedList.SortedList(IComparer)-Konstruktor instanziiert wird.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.

Caution

Die Tuple<T1,T2,T3>.IStructuralComparable.CompareTo-Methode ist für die Verwendung in Sortiervorgängen vorgesehen.The Tuple<T1,T2,T3>.IStructuralComparable.CompareTo method is intended for use in sorting operations. Er sollte nicht verwendet werden, wenn der Hauptzweck eines Vergleichs darin besteht, zu bestimmen, ob zwei Objekte gleich sind.It should not be used when the primary purpose of a comparison is to determine whether two objects are equal. Um zu ermitteln, ob zwei Objekte gleich sind, müssen Sie die Tuple<T1,T2,T3>.IStructuralEquatable.Equals-Methode aufzurufen.To determine whether two objects are equal, call the Tuple<T1,T2,T3>.IStructuralEquatable.Equals method.

Applies to

See also