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

Definition

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

valueValue 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,T4,T5,T6>-Objekt.other is not a Tuple<T1,T2,T3,T4,T5,T6> object.

Examples

Im folgenden Beispiel wird ein Array von Tuple<T1,T2,T3,T4,T5,T6>-Objekten erstellt, das auffüllungs Daten für drei US-amerikanische Städte von 1960 bis 2000 enthält.The following example creates an array of Tuple<T1,T2,T3,T4,T5,T6> objects that contains population data for three U.S. cities from 1960 to 2000. Die erste Komponente des sextupels ist der Name der Stadt.The sextuple's first component is the city name. Die verbleibenden fünf Komponenten stellen die Auffüllung in Abständen von 10 Jahren zwischen 1960 und 2000 dar.The remaining five components represent the population at 10-year intervals from 1960 to 2000.

Die PopulationComparer-Klasse stellt eine IComparer Implementierung bereit, mit der das Array von sextupel nach einer seiner Komponenten sortiert werden kann.The PopulationComparer class provides an IComparer implementation that allows the array of sextuples to be sorted by any one of its components. Zwei Werte werden für die PopulationComparer-Klasse im Konstruktor bereitgestellt: die Position der Komponente, die die Sortierreihenfolge definiert, und ein Boolean Wert, der angibt, ob die tupelobjekte in aufsteigender oder absteigender Reihenfolge sortiert werden sollen.Two values are provided to the PopulationComparer class in its constructor: The position of the component that defines the sort order, and a Boolean value that indicates whether the tuple objects should be sorted in ascending or descending order.

Das Beispiel zeigt dann die Elemente im Array in unsortierten Reihenfolge an, sortiert sie nach der dritten Komponente (die Population in 1970) und zeigt Sie an und sortiert Sie dann nach der sechsten Komponente (die Population in 2000) und zeigt Sie an.The example then displays the elements in the array in unsorted order, sorts them by the third component (the population in 1970) and displays them, and then sorts them by the sixth component (the population in 2000) and displays them.

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

public class PopulationComparer<T1, T2, T3, T4, T5, T6> : IComparer
{
   private int itemPosition;
   private int multiplier = -1;

   public PopulationComparer(int component) : this(component, true)
   { }

   public PopulationComparer(int component, bool descending)
   {
      if (! descending) multiplier = 1;

      if (component <= 0 || component > 6)
         throw new ArgumentException("The component argument is out of range.");

      itemPosition = component;
   }

   public int Compare(object x, object y)
   {
      var tX = x as Tuple<T1, T2, T3, T4, T5, T6>;
      if (tX == null)
      {
         return 0;
      }
      else
      {
         var tY = y as Tuple<T1, T2, T3, T4, T5, T6>;
         switch (itemPosition)
         {
            case 1:
               return Comparer<T1>.Default.Compare(tX.Item1, tY.Item1) * multiplier;
            case 2:
               return Comparer<T2>.Default.Compare(tX.Item2, tY.Item2) * multiplier;
            case 3:
               return Comparer<T3>.Default.Compare(tX.Item3, tY.Item3) * multiplier;
            case 4:
               return Comparer<T4>.Default.Compare(tX.Item4, tY.Item4) * multiplier;
            case 5:
               return Comparer<T5>.Default.Compare(tX.Item5, tY.Item5) * multiplier;
            case 6:
               return Comparer<T6>.Default.Compare(tX.Item6, tY.Item6) * multiplier;
            default:
               return Comparer<T1>.Default.Compare(tX.Item1, tY.Item1) * multiplier;
         }
      }
   }
}

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, new PopulationComparer<string, int, int, int, int, int>(3));

      // Display array in sorted order.
      Console.WriteLine("Sorted by population in 1970:");
      foreach (var city in cities)
         Console.WriteLine(city.ToString());
      Console.WriteLine();

      Array.Sort(cities, new PopulationComparer<string, int, int, int, int, int>(6));

      // Display array in sorted order.
      Console.WriteLine("Sorted by population in 2000:");
      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)
//    
//    Sorted by population in 1970:
//    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
//    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
//    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
//    
//    Sorted by population in 2000:
//    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
//    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
//    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
Imports System.Collections
Imports System.Collections.Generic

Public Class PopulationComparer(Of T1, T2, T3, T4, T5, T6) : Implements IComparer
   Private itemPosition As Integer
   Private multiplier As Integer = -1
      
   Public Sub New(component As Integer)
      Me.New(component, True)
   End Sub
   
   Public Sub New(component As Integer, descending As Boolean)
      If Not descending Then multiplier = 1
      
      If component <= 0 Or component > 6 Then 
         Throw New ArgumentException("The component argument is out of range.")
      End If
      itemPosition = component
   End Sub 
   
   Public Function Compare(x As Object, y As Object) As Integer _
                   Implements IComparer.Compare
 
      Dim tX = TryCast(x, Tuple(Of T1, T2, T3, T4, T5, T6))
      If tX Is Nothing Then
         Return 0
      Else
         Dim tY = DirectCast(y, Tuple(Of T1, T2, T3, T4, T5, T6))
         Select Case itemPosition
            Case 1
               Return Comparer(Of T1).Default.Compare(tX.Item1, tY.Item1) * multiplier
            Case 2
               Return Comparer(Of T2).Default.Compare(tX.Item2, tY.Item2) * multiplier
            Case 3
               Return Comparer(Of T3).Default.Compare(tX.Item3, tY.Item3) * multiplier
            Case 4
               Return Comparer(Of T4).Default.Compare(tX.Item4, tY.Item4) * multiplier
            Case 5
               Return Comparer(Of T5).Default.Compare(tX.Item5, tY.Item5) * multiplier
            Case 6
               Return Comparer(Of T6).Default.Compare(tX.Item6, tY.Item6) * multiplier
            ' This should never happen.
            Case Else
               Return 0
         End Select      
      End If
   End Function
End Class

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, New PopulationComparer(Of String, Integer, Integer, Integer, Integer, Integer)(3)) 
                           
      ' Display array in sorted order.
      Console.WriteLine("Sorted by population in 1970:")
      For Each city In cities
         Console.WriteLine(city.ToString())
      Next
      Console.WriteLine()
      
      Array.Sort(cities, New PopulationComparer(Of String, Integer, Integer, Integer, Integer, Integer)(6))
                           
      ' Display array in sorted order.
      Console.WriteLine("Sorted by population in 2000:")
      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)
'    
'    Sorted by population in 1970:
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)
'    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
'    
'    Sorted by population in 2000:
'    (New York, 7781984, 7894862, 7071639, 7322564, 8008278)
'    (Los Angeles, 2479015, 2816061, 2966850, 3485398, 3694820)
'    (Chicago, 3550904, 3366957, 3005072, 2783726, 2896016)

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,T4,T5,T6>-Instanz in eine IStructuralComparable-Schnittstelle umgewandelt wird.It can be used only when the Tuple<T1,T2,T3,T4,T5,T6> instance is cast to an IStructuralComparable interface.

Mit dieser Methode können Sie angepasste Vergleiche von Tuple<T1,T2,T3,T4,T5,T6>-Objekten definieren.This method lets you define customized comparisons of Tuple<T1,T2,T3,T4,T5,T6> objects. Sie können diese Methode z. b. verwenden, um Tuple<T1,T2,T3,T4,T5,T6> Objekte auf der Grundlage des Werts einer bestimmten Komponente zu ordnen.For example, you can use this method to order Tuple<T1,T2,T3,T4,T5,T6> objects based on the value of a specific component.

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 IStructuralComparable.CompareTo-Methode ist für die Verwendung in Sortiervorgängen vorgesehen.The 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 IStructuralEquatable.Equals(Object, IEqualityComparer)-Methode aufzurufen.To determine whether two objects are equal, call the IStructuralEquatable.Equals(Object, IEqualityComparer) method.

Applies to