Enumerable.OrderByDescending Метод

Определение

Сортирует элементы последовательности в порядке убывания.Sorts the elements of a sequence in descending order.

Перегрузки

OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)

Сортирует элементы последовательности в порядке убывания с использованием указанного компаратора.Sorts the elements of a sequence in descending order by using a specified comparer.

OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)

Сортирует элементы последовательности в порядке убывания ключа.Sorts the elements of a sequence in descending order according to a key.

OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)

Сортирует элементы последовательности в порядке убывания с использованием указанного компаратора.Sorts the elements of a sequence in descending order by using a specified comparer.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderByDescending(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector, System::Collections::Generic::IComparer<TKey> ^ comparer);
public static System.Linq.IOrderedEnumerable<TSource> OrderByDescending<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector, System.Collections.Generic.IComparer<TKey> comparer);
static member OrderByDescending : seq<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedEnumerable<'Source>
<Extension()>
Public Function OrderByDescending(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), comparer As IComparer(Of TKey)) As IOrderedEnumerable(Of TSource)

Параметры типа

TSource

Тип элементов source.The type of the elements of source.

TKey

Тип ключа, возвращаемого функцией keySelector.The type of the key returned by keySelector.

Параметры

source
IEnumerable<TSource>

Последовательность значений, которые следует упорядочить.A sequence of values to order.

keySelector
Func<TSource,TKey>

Функция, извлекающая ключ из элемента.A function to extract a key from an element.

comparer
IComparer<TKey>

Компаратор IComparer<T>, используемый для сравнения ключей.An IComparer<T> to compare keys.

Возвраты

Объект IOrderedEnumerable<TElement>, элементы которого отсортированы по ключу в порядке убывания.An IOrderedEnumerable<TElement> whose elements are sorted in descending order according to a key.

Исключения

Параметр source или keySelector имеет значение null.source or keySelector is null.

Примеры

В следующем примере кода показано, как использовать OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>) для сортировки элементов последовательности в порядке убывания с помощью функции преобразования и пользовательского компаратора.The following code example demonstrates how to use OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>) to sort the elements of a sequence in descending order by using a transform function and a custom comparer.

/// <summary>
/// This IComparer class sorts by the fractional part of the decimal number.
/// </summary>
public class SpecialComparer : IComparer<decimal>
{
    /// <summary>
    /// Compare two decimal numbers by their fractional parts.
    /// </summary>
    /// <param name="d1">The first decimal to compare.</param>
    /// <param name="d2">The second decimal to compare.</param>
    /// <returns>1 if the first decimal's fractional part 
    /// is greater than the second decimal's fractional part,
    /// -1 if the first decimal's fractional
    /// part is less than the second decimal's fractional part,
    /// or the result of calling Decimal.Compare()
    /// if the fractional parts are equal.</returns>
    public int Compare(decimal d1, decimal d2)
    {
        decimal fractional1, fractional2;

        // Get the fractional part of the first number.
        try
        {
            fractional1 = decimal.Remainder(d1, decimal.Floor(d1));
        }
        catch (DivideByZeroException)
        {
            fractional1 = d1;
        }
        // Get the fractional part of the second number.
        try
        {
            fractional2 = decimal.Remainder(d2, decimal.Floor(d2));
        }
        catch (DivideByZeroException)
        {
            fractional2 = d2;
        }

        if (fractional1 == fractional2)
            return Decimal.Compare(d1, d2);
        else if (fractional1 > fractional2)
            return 1;
        else
            return -1;
    }
}

public static void OrderByDescendingEx1()
{
    List<decimal> decimals =
        new List<decimal> { 6.2m, 8.3m, 0.5m, 1.3m, 6.3m, 9.7m };

    IEnumerable<decimal> query =
        decimals.OrderByDescending(num =>
                                       num, new SpecialComparer());

    foreach (decimal num in query)
    {
        Console.WriteLine(num);
    }
}

/*
 This code produces the following output:

 9.7
 0.5
 8.3
 6.3
 1.3
 6.2
*/
' This class provides a custom implementation 
' of the IComparer.Compare() method.
Class SpecialComparer
    Implements IComparer(Of Decimal)
    ''' <summary>
    ''' Compare two decimal numbers by their fractional parts.
    ''' </summary>
    ''' <param name="d1">The first decimal to compare.</param>
    ''' <param name="d2">The second decimal to compare.</param>
    ''' <returns>1 if the first decimal's fractional part is greater than
    ''' the second decimal's fractional part,
    ''' -1 if the first decimal's fractional
    ''' part is less than the second decimal's fractional part,
    ''' or the result of calling Decimal.Compare()
    ''' if the fractional parts are equal.</returns>
    Function Compare(ByVal d1 As Decimal, ByVal d2 As Decimal) As Integer _
    Implements IComparer(Of Decimal).Compare

        Dim fractional1 As Decimal
        Dim fractional2 As Decimal

        ' Get the fractional part of the first number.
        Try
            fractional1 = Decimal.Remainder(d1, Decimal.Floor(d1))
        Catch ex As DivideByZeroException
            fractional1 = d1
        End Try

        ' Get the fractional part of the second number.
        Try
            fractional2 = Decimal.Remainder(d2, Decimal.Floor(d2))
        Catch ex As DivideByZeroException
            fractional2 = d2
        End Try

        If (fractional1 = fractional2) Then
            ' The fractional parts are equal, so compare the entire numbers.
            Return Decimal.Compare(d1, d2)
        ElseIf (fractional1 > fractional2) Then
            Return 1
        Else
            Return -1
        End If
    End Function
End Class

Sub OrderByDescendingEx1()
    ' Create a list of decimal values.
    Dim decimals As New List(Of Decimal)(New Decimal() _
                                     {6.2D, 8.3D, 0.5D, 1.3D, 6.3D, 9.7D})

    ' Order the elements of the list by passing
    ' in the custom IComparer class.
    Dim query As IEnumerable(Of Decimal) =
    decimals.OrderByDescending(Function(num) num,
                               New SpecialComparer())

    Dim output As New System.Text.StringBuilder
    For Each num As Decimal In query
        output.AppendLine(num)
    Next

    ' Display the output.
    MsgBox(output.ToString())
End Sub

' This code produces the following output:
'
' 9.7
' 0.5
' 8.3
' 6.3
' 1.3
' 6.2

Комментарии

Этот метод реализуется с помощью отложенного выполнения.This method is implemented by using deferred execution. Немедленное возвращаемое значение — это объект, в котором хранятся все сведения, необходимые для выполнения действия.The immediate return value is an object that stores all the information that is required to perform the action. Запрос, представленный этим методом, не выполняется до тех пор, пока объект не будет перечислен либо путем вызова метода GetEnumerator напрямую, либо с помощью @no__t- C# 1 в Visual или For Each в Visual Basic.The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

Чтобы упорядочить последовательность по значениям элементов, укажите функцию Identity (x => x в Visual C# или Function(x) x в Visual Basic) для keySelector.To order a sequence by the values of the elements themselves, specify the identity function (x => x in Visual C# or Function(x) x in Visual Basic) for keySelector.

Для расширения типа IOrderedEnumerable<TElement>, который является типом возвращаемого значения этого метода, определены два метода.Two methods are defined to extend the type IOrderedEnumerable<TElement>, which is the return type of this method. Эти два метода, а именно ThenBy и ThenByDescending, позволяют указать дополнительные критерии сортировки для сортировки последовательности.These two methods, namely ThenBy and ThenByDescending, enable you to specify additional sort criteria to sort a sequence. ThenBy и ThenByDescending также возвращают IOrderedEnumerable<TElement>, то есть может быть установлено любое число последовательных вызовов ThenBy или ThenByDescending.ThenBy and ThenByDescending also return an IOrderedEnumerable<TElement>, which means any number of consecutive calls to ThenBy or ThenByDescending can be made.

Примечание

Поскольку IOrderedEnumerable<TElement> наследует от IEnumerable<T>, можно вызвать OrderBy или OrderByDescending в результатах вызова OrderBy, OrderByDescending, ThenBy или ThenByDescending.Because IOrderedEnumerable<TElement> inherits from IEnumerable<T>, you can call OrderBy or OrderByDescending on the results of a call to OrderBy, OrderByDescending, ThenBy or ThenByDescending. В этом случае вводится новый первичный порядок, который игнорирует ранее установленный порядок.Doing this introduces a new primary ordering that ignores the previously established ordering.

Если comparer равно null, для сравнения ключей используется компаратор по умолчанию Default.If comparer is null, the default comparer Default is used to compare keys.

Этот метод выполняет стабильную сортировку; то есть, если ключи двух элементов равны, порядок элементов сохраняется.This method performs a stable sort; that is, if the keys of two elements are equal, the order of the elements is preserved. Напротив, нестабильная сортировка не сохраняет порядок элементов с одинаковым ключом.In contrast, an unstable sort does not preserve the order of elements that have the same key.

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

OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)

Сортирует элементы последовательности в порядке убывания ключа.Sorts the elements of a sequence in descending order according to a key.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderByDescending(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector);
public static System.Linq.IOrderedEnumerable<TSource> OrderByDescending<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);
static member OrderByDescending : seq<'Source> * Func<'Source, 'Key> -> System.Linq.IOrderedEnumerable<'Source>
<Extension()>
Public Function OrderByDescending(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey)) As IOrderedEnumerable(Of TSource)

Параметры типа

TSource

Тип элементов source.The type of the elements of source.

TKey

Тип ключа, возвращаемого функцией keySelector.The type of the key returned by keySelector.

Параметры

source
IEnumerable<TSource>

Последовательность значений, которые следует упорядочить.A sequence of values to order.

keySelector
Func<TSource,TKey>

Функция, извлекающая ключ из элемента.A function to extract a key from an element.

Возвраты

Объект IOrderedEnumerable<TElement>, элементы которого отсортированы по ключу в порядке убывания.An IOrderedEnumerable<TElement> whose elements are sorted in descending order according to a key.

Исключения

Значение параметра source или keySelectornull.source or keySelector is null.

Комментарии

Этот метод реализуется с помощью отложенного выполнения.This method is implemented by using deferred execution. Немедленное возвращаемое значение — это объект, в котором хранятся все сведения, необходимые для выполнения действия.The immediate return value is an object that stores all the information that is required to perform the action. Запрос, представленный этим методом, не выполняется до тех пор, пока объект не будет перечислен либо путем вызова метода GetEnumerator напрямую, либо с помощью @no__t- C# 1 в Visual или For Each в Visual Basic.The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

Чтобы упорядочить последовательность по значениям элементов, укажите функцию Identity (x => x в Visual C# или Function(x) x в Visual Basic) для keySelector.To order a sequence by the values of the elements themselves, specify the identity function (x => x in Visual C# or Function(x) x in Visual Basic) for keySelector.

Пример этого метода см. в разделе OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>).For an example of this method, see OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>).

Для расширения типа IOrderedEnumerable<TElement>, который является типом возвращаемого значения этого метода, определены два метода.Two methods are defined to extend the type IOrderedEnumerable<TElement>, which is the return type of this method. Эти два метода, а именно ThenBy и ThenByDescending, позволяют указать дополнительные критерии сортировки для сортировки последовательности.These two methods, namely ThenBy and ThenByDescending, enable you to specify additional sort criteria to sort a sequence. ThenBy и ThenByDescending также возвращают IOrderedEnumerable<TElement>, то есть может быть установлено любое число последовательных вызовов ThenBy или ThenByDescending.ThenBy and ThenByDescending also return an IOrderedEnumerable<TElement>, which means any number of consecutive calls to ThenBy or ThenByDescending can be made.

Примечание

Поскольку IOrderedEnumerable<TElement> наследует от IEnumerable<T>, можно вызвать OrderBy или OrderByDescending в результатах вызова OrderBy, OrderByDescending, ThenBy или ThenByDescending.Because IOrderedEnumerable<TElement> inherits from IEnumerable<T>, you can call OrderBy or OrderByDescending on the results of a call to OrderBy, OrderByDescending, ThenBy or ThenByDescending. В этом случае вводится новый первичный порядок, который игнорирует ранее установленный порядок.Doing this introduces a new primary ordering that ignores the previously established ordering.

Этот метод сравнивает ключи с помощью компаратора по умолчанию Default.This method compares keys by using the default comparer Default.

Этот метод выполняет стабильную сортировку; то есть, если ключи двух элементов равны, порядок элементов сохраняется.This method performs a stable sort; that is, if the keys of two elements are equal, the order of the elements is preserved. Напротив, нестабильная сортировка не сохраняет порядок элементов с одинаковым ключом.In contrast, an unstable sort does not preserve the order of elements that have the same key.

В синтаксисе выражения запроса предложение orderby descending (Visual C#) или Order By Descending (Visual Basic) преобразуется в вызов OrderByDescending.In query expression syntax, an orderby descending (Visual C#) or Order By Descending (Visual Basic) clause translates to an invocation of OrderByDescending.

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

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