Export (0) Print
Expand All

Tuple(Of T1, T2, T3, T4, T5).IComparable.CompareTo Method

Compares the current Tuple(Of T1, T2, T3, T4, T5) object to a specified object 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)

'Declaration
Private Function CompareTo ( _
	obj As Object _
) As Integer Implements IComparable.CompareTo

Parameters

obj
Type: System.Object
An object to compare with the current instance.

Return Value

Type: System.Int32
A signed integer that indicates the relative position of this instance and obj in the sort order, as shown in the following table.

Value

Description

A negative integer

This instance precedes obj.

Zero

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

A positive integer

This instance follows obj.

Implements

IComparable.CompareTo(Object)

ExceptionCondition
ArgumentException

obj is not a Tuple(Of T1, T2, T3, T4, T5) object.

This member is an explicit interface member implementation. It can be used only when the Tuple(Of T1, T2, T3, T4, T5) instance is cast to an IComparable interface.

This method provides the IComparable.CompareTo implementation for the Tuple(Of T1, T2, T3, T4, T5) class. Although the method can be called directly, it is most commonly called by the default overloads of collection-sorting methods, such as Array.Sort(Array).

Caution noteCaution:

The IComparable.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 Tuple(Of T1, T2, T3, T4, T5).Equals(Object) method.

The IComparable.CompareTo(Object) method uses the Comparer(Of T).Default comparer.

The following example creates an array of Tuple(Of T1, T2, T3, T4, T5) objects that contain career statistics for running backs in American professional football. The five 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. The output shows that the array has been sorted by name, which is the first component. Note that the example does not directly call the IComparable.CompareTo method. This method is called implicitly by the Sort(Array) method for each element in the array.


Imports System.Collections.Generic

Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' 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   
      Dim 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.
      outputBlock.Text &= "The values in unsorted order:" & vbCrLf
      For Each runningBack In runningBacks
         outputBlock.Text &= runningBack.ToString() & vbCrLf
      Next
      outputBlock.Text &= vbCrLf

      ' Sort the array
      Array.Sort(runningBacks)

      ' Display the array in sorted order.
      outputBlock.Text &= "The values in sorted order:" & vbCrLf
      For Each runningBack In runningBacks
         outputBlock.Text &= runningBack.ToString() & vbCrLf
      Next
   End Sub
End Module
' 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)


Silverlight

Supported in: 5, 4

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show:
© 2014 Microsoft