Tuple<T1>.IStructuralComparable.CompareTo(Object, IComparer) Метод

Определение

Сравнивает текущий объект Tuple<T1> с указанным объектом, используя заданный компаратор, и возвращает целое число, которое показывает положение текущего объекта относительно указанного объекта в порядке сортировки: перед объектом, после него или в той же позиции.Compares the current Tuple<T1> 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);
Function CompareTo (other As Object, comparer As IComparer) As Integer Implements IStructuralComparable.CompareTo

Параметры

other
Object

Объект для сравнения с текущим экземпляром.An object to compare with the current instance.

comparer
IComparer

Объект, предоставляющий пользовательские правила для сравнения.An object that provides custom rules for comparison.

Возвраты

Целое число со знаком, определяющее относительное положение экземпляра и параметра other в порядке сортировки, как показано в следующей таблице.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 Данный экземпляр предшествует параметру other.This instance precedes other.
НульZero У этого экземпляра та же позиция в порядке сортировки, что и у other.This instance and other have the same position in the sort order.
Положительное целое числоA positive integer Данный экземпляр стоит после параметра other.This instance follows other.

Реализации

Исключения

other не является объектом Tuple<T1>.other is not a Tuple<T1> object.

Примеры

В следующем примере определяется универсальный класс с именем DescendingComparer , который IComparer<T> реализует интерфейс.The following example defines a generic class named DescendingComparer that implements the IComparer<T> interface. DescendingComparerСортирует объекты по убыванию, а не по возрастанию, отменяя значение, возвращаемое компаратором по умолчанию для определенного типа.DescendingComparer sorts objects in descending rather than ascending order by reversing the value returned by the default comparer for a particular type. Затем экземпляр универсального DescendingComparer класса передается Array.Sort(Array, IComparer) в метод Tuple<T1> для сортировки массива объектов в убывающем порядке.An instance of the generic DescendingComparer class is then passed to the Array.Sort(Array, IComparer) method to sort an array of Tuple<T1> objects in descending order. Обратите внимание, что в этом примере IStructuralComparable.CompareTo метод не вызывается напрямую.Note that the example does not directly call the IStructuralComparable.CompareTo method. Этот метод вызывается неявно Array.Sort(Array, IComparer) методом для каждого элемента в массиве.This method is called implicitly by the Array.Sort(Array, IComparer) method for each element in the array.

using System;
using System.Collections.Generic;

public class DescendingComparer<T> : IComparer<T>
{
    public int Compare(T x, T y) 
    {
        return -1 * Comparer<T>.Default.Compare(x, y);
    }
}

class CompareTo2
{
   static void Main()
   {
       Tuple<Double>[] values = { Tuple.Create(13.54),
                                  Tuple.Create(Double.NaN),
                                  Tuple.Create(-189.42993),
                                  Tuple.Create(Double.PositiveInfinity),
                                  Tuple.Create(Double.Epsilon),
                                  Tuple.Create(1.934E-17),
                                  Tuple.Create(Double.NegativeInfinity),
                                  Tuple.Create(-0.000000000003588),
                                  null };
       Console.WriteLine("The values in unsorted order:");
       foreach (var value in values)
           if (value != null)
               Console.WriteLine("   {0}", value.Item1);
           else
               Console.WriteLine("   <null>");
       Console.WriteLine();

       Array.Sort(values, new DescendingComparer<Tuple<Double>>());

       Console.WriteLine("The values sorted in descending order:");
       foreach (var value in values)
           if (value != null)
               Console.WriteLine("   {0}", value.Item1);
           else
               Console.WriteLine("   <null>");
    }
}
// The example displays the following output:
//      The values in unsorted order:
//         13.54
//         NaN
//         -189.42993
//         Infinity
//         4.94065645841247E-324
//         1.934E-17
//         -Infinity
//         -3.588E-12
//
//      The values sorted in descending order:
//         Infinity
//         13.54
//         1.934E-17
//         4.94065645841247E-324
//         -3.588E-12
//         -189.42993
//         -Infinity
//         NaN
Imports System.Collections.Generic

Public Class DescendingComparer(Of T) : Implements IComparer(Of T)
    Public Function Compare(ByVal x As T, ByVal y As T) As Integer Implements IComparer(Of T).Compare
        Return -1 * Comparer(Of T).Default.Compare(x, y)
    End Function
End Class

Module Example
    Sub Main()
        Dim values() = { Tuple.Create(13.54),
                         Tuple.Create(Double.NaN),
                         Tuple.Create(-189.42993),
                         Tuple.Create(Double.PositiveInfinity),
                         Tuple.Create(Double.Epsilon),
                         Tuple.Create(1.934E-17),
                         Tuple.Create(Double.NegativeInfinity),
                         Tuple.Create(-0.000000000003588),
                         Nothing}

        Console.WriteLine("The values in unsorted order:")
        For Each value As Tuple(Of Double) In values
            If value IsNot Nothing Then
                Console.WriteLine("   {0}", value.Item1)
            Else
                Console.WriteLine("   <null>")
            End If
        Next
        Console.WriteLine()

        Array.Sort(values, New DescendingComparer(Of Tuple(Of Double)))

        Console.WriteLine("The values sorted in descending order:")
        For Each value As Tuple(Of Double) In values
            If value IsNot Nothing Then
                Console.WriteLine("   {0}", value.Item1)
            Else
                Console.WriteLine("   <null>")
            End If
        Next
    End Sub
End Module
' The example displays the following output:
'      The values in unsorted order:
'         13.54
'         NaN
'         -189.42993
'         Infinity
'         4.94065645841247E-324
'         1.934E-17
'         -Infinity
'         -3.588E-12
'
'      The values sorted in descending order:
'         Infinity
'         13.54
'         1.934E-17
'         4.94065645841247E-324
'         -3.588E-12
'         -189.42993
'         -Infinity
'         NaN

Комментарии

Несмотря на то, что этот метод можно вызывать напрямую, он чаще всего вызывается методами сортировки IComparer коллекций, которые включают параметры для упорядочивания элементов коллекции.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. Например, Array.Sort(Array, IComparer) метод вызывается методом Add и методом SortedList SortedList.SortedList(IComparer) объекта, экземпляр которого создается с помощью конструктора.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.

Внимание!

IStructuralComparable.CompareTo Метод предназначен для использования в операциях сортировки.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. Чтобы определить, равны ли два объекта, вызовите IStructuralEquatable.Equals метод.To determine whether two objects are equal, call the IStructuralEquatable.Equals method.

Применяется к

Дополнительно