Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Tuple<T1, T2, T3, T4, T5>.IStructuralComparable.CompareTo Method

Compares the current Tuple<T1, T2, T3, T4, T5> 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.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
int IStructuralComparable.CompareTo(
	Object other,
	IComparer comparer
)

Parameters

other
Type: System.Object

An object to compare with the current instance.

comparer
Type: System.Collections.IComparer

An object that provides custom rules for comparison.

Return Value

Type: System.Int32
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

This instance precedes other.

Zero

This instance and other have the same position in the sort order.

A positive integer

This instance follows other.

Implements

IStructuralComparable.CompareTo(Object, IComparer)
ExceptionCondition
ArgumentException

other is not a Tuple<T1, T2, T3, T4, T5> object.

This member is an explicit interface member implementation. It can be used only when the Tuple<T1, T2, T3, T4, T5> instance is cast to an IStructuralComparable interface.

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. 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 noteCaution

The IStructuralComparable.CompareTo 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. To determine whether two objects are equal, call the IStructuralEquatable.Equals(Object, IEqualityComparer) method.

The following example creates an array of Tuple<T1, T2, T3, T4, T5> objects that contain career statistical data for running backs in American professional football. The 5-tuple's components consist of the player's name, the number of games in which he played, the number of carries or attempts, the total number of yards gained, and the number of touchdowns scored. The example displays the components of each tuple in the array in unsorted order, sorts the array, and then calls ToString to display each tuple in sorted order. To sort the array, the example defines a generic YardsGained class that implements the IComparer interface and sorts the Tuple<T1, T2, T3, T4, T5> objects in descending order by the value of their fourth component (yards gained) rather than by their first component. Note that the example does not directly call the IStructuralComparable.CompareTo method. 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 YardsGained<T1, T2, T3, T4, T5> : IComparer
{
   public int Compare(object x, object y)
   {
      Tuple<T1, T2, T3, T4, T5> tX = x as Tuple<T1, T2, T3, T4, T5>;
      if (tX == null)
      { 
         return 0;
      }   
      else
      {
         Tuple<T1, T2, T3, T4, T5> tY = y as Tuple<T1, T2, T3, T4, T5>;
         return -1 * Comparer<T4>.Default.Compare(tX.Item4, tY.Item4);             
      }
   }
}

public class Example
{
   public static void Main()
   {
      // Organization of runningBacks 5-tuple: 
      //    Component 1: Player name 
      //    Component 2: Number of games played 
      //    Component 3: Number of attempts (carries) 
      //    Component 4: Number of yards gained  
      //    Component 5: Number of touchdowns   
      Tuple<string, int, int, int, int>[] runningBacks =
           { Tuple.Create("Payton, Walter", 190, 3838, 16726, 110),  
             Tuple.Create("Sanders, Barry", 153, 3062, 15269, 99),            
             Tuple.Create("Brown, Jim", 118, 2359, 12312, 106),            
             Tuple.Create("Dickerson, Eric", 144, 2996, 13259, 90),            
             Tuple.Create("Faulk, Marshall", 176, 2836, 12279, 100) }; 

      // Display the array in unsorted order.
      Console.WriteLine("The values in unsorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
      Console.WriteLine();

      // Sort the array
      Array.Sort(runningBacks, new YardsGained<string, int, int, int, int>());

      // Display the array in sorted order.
      Console.WriteLine("The values in sorted order:");
      foreach (var runningBack in runningBacks)
         Console.WriteLine(runningBack.ToString());
   }
}
// The example displays the following output: 
//       The values in unsorted order: 
//       (Payton, Walter, 190, 3838, 16726, 110) 
//       (Sanders, Barry, 153, 3062, 15269, 99) 
//       (Brown, Jim, 118, 2359, 12312, 106) 
//       (Dickerson, Eric, 144, 2996, 13259, 90) 
//       (Faulk, Marshall, 176, 2836, 12279, 100) 
//        
//       The values in sorted order: 
//       (Brown, Jim, 118, 2359, 12312, 106) 
//       (Dickerson, Eric, 144, 2996, 13259, 90) 
//       (Faulk, Marshall, 176, 2836, 12279, 100) 
//       (Payton, Walter, 190, 3838, 16726, 110) 
//       (Sanders, Barry, 153, 3062, 15269, 99)

.NET Framework

Supported in: 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.