Tuple<T1, T2, T3, T4, T5, T6, T7, TRest>.IStructuralComparable.CompareTo Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Compares the current Tuple<T1, T2, T3, T4, T5, T6, T7, TRest> 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.
Assembly: mscorlib (in mscorlib.dll)
- Type: System.Object
An object to compare with the current instance.
- Type: System.Collections.IComparer
An object that provides custom rules for comparison.
Return ValueType: 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.
A negative integer
This instance precedes other.
This instance and other have the same position in the sort order.
A positive integer
This instance follows other.
This method lets you define customized comparisons of Tuple<T1, T2, T3, T4, T5, T6, T7, TRest> objects. For example, you can use this method to order Tuple<T1, T2, T3, T4, T5, T6, T7, TRest> objects based on the value of a specific component.
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, such as the Array.Sort(Array, IComparer) method.
The 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 method.
The following example creates an array of Tuple<T1, T2, T3, T4, T5, T6, T7, TRest> objects that contains population data for four U.S. cities from 1940 to 2000. The octuple's first component is the city name. The remaining six components represent the population at 10-year intervals from 1940 to 2000.
The PopulationComparer class provides an IComparer implementation that allows the array of octuples to be sorted by any one of its components. 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.
The example then displays the elements in the array in unsorted order, sorts them by the third component (the population in 1950) and displays them, and then sorts them by the eighth component (the population in 2000) and displays them.