Enumerable.OrderByDescending Метод

Определение

Пространство имен:

System.Linq

Сборка:

System.Linq.dll

Сортирует элементы последовательности в порядке убывания.

Перегрузки

OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	Сортирует элементы последовательности в порядке убывания ключа.
OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)	Сортирует элементы последовательности в порядке убывания с использованием указанного компаратора.

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

Исходный код:

OrderBy.cs

Сортирует элементы последовательности в порядке убывания ключа.

C#

public static System.Linq.IOrderedEnumerable<TSource> OrderByDescending<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);

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

TSource

Тип элементов source.

TKey

Тип ключа, возвращаемого функцией keySelector.

Параметры

source

IEnumerable<TSource>

Последовательность значений, которые следует упорядочить.

keySelector

Func<TSource,TKey>

Функция, извлекающая ключ из элемента.

Возвращаемое значение

IOrderedEnumerable<TSource>

Объект IOrderedEnumerable<TElement>, элементы которого отсортированы по ключу в порядке убывания.

Исключения

ArgumentNullException

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

Комментарии

Этот метод реализуется с помощью отложенного выполнения. Немедленно возвращаемое значение — это объект, в котором хранятся все сведения, необходимые для выполнения действия. Запрос, представленный этим методом, не выполняется до тех пор, пока объект не будет перечислен либо путем вызова его GetEnumerator метода напрямую, либо с помощью foreach в C# или For Each в Visual Basic.

Чтобы упорядочить последовательность по значениям самих элементов, укажите функцию идентификации (x => x в C# или Function(x) x в Visual Basic) для keySelector.

Пример этого метода см. в разделе OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>).

Определены два метода для расширения типа IOrderedEnumerable<TElement>, который является возвращаемым типом этого метода. Эти два метода, а именно ThenBy и ThenByDescending, позволяют указать дополнительные критерии сортировки для сортировки последовательности. ThenBy а ThenByDescending также возвращает значение IOrderedEnumerable<TElement>, что означает любое количество последовательных вызовов к ThenBy или ThenByDescending .

Примечание

Так как IOrderedEnumerable<TElement> наследуется от IEnumerable<T>, можно вызвать OrderBy или OrderByDescending в результатах вызова OrderBy, OrderByDescendingThenBy или ThenByDescending. Это позволяет создать новый первичный порядок, который игнорирует ранее установленный порядок.

Этот метод сравнивает ключи с помощью средства сравнения Defaultпо умолчанию .

Этот метод выполняет стабильную сортировку; То есть, если ключи двух элементов равны, порядок элементов сохраняется. Напротив, нестабильная сортировка не сохраняет порядок элементов с одинаковым ключом.

В синтаксисе orderby descending выражения запроса предложение (C#) или Order By Descending (Visual Basic) преобразуется в вызов OrderByDescending.

См. также раздел

• OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)
• Предложение orderby (Справочник по C#)
• Предложение Order By (Visual Basic)

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

Исходный код:

OrderBy.cs

Сортирует элементы последовательности в порядке убывания с использованием указанного компаратора.

C#

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);

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

TSource

Тип элементов source.

TKey

Тип ключа, возвращаемого функцией keySelector.

Параметры

source

IEnumerable<TSource>

Последовательность значений, которые следует упорядочить.

keySelector

Func<TSource,TKey>

Функция, извлекающая ключ из элемента.

comparer

IComparer<TKey>

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

Возвращаемое значение

IOrderedEnumerable<TSource>

Объект IOrderedEnumerable<TElement>, элементы которого отсортированы по ключу в порядке убывания.

Исключения

ArgumentNullException

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

Примеры

В следующем примере кода демонстрируется использование OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>) для сортировки элементов последовательности в порядке убывания с помощью функции преобразования и пользовательского средства сравнения.

C#

/// <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
*/

Комментарии

Этот метод реализуется с помощью отложенного выполнения. Немедленно возвращаемое значение — это объект, в котором хранятся все сведения, необходимые для выполнения действия. Запрос, представленный этим методом, не выполняется до тех пор, пока объект не будет перечислен либо путем вызова его GetEnumerator метода напрямую, либо с помощью foreach в C# или For Each в Visual Basic.

Чтобы упорядочить последовательность по значениям самих элементов, укажите функцию идентификации (x => x в C# или Function(x) x в Visual Basic) для keySelector.

Определены два метода для расширения типа IOrderedEnumerable<TElement>, который является возвращаемым типом этого метода. Эти два метода, а именно ThenBy и ThenByDescending, позволяют указать дополнительные критерии сортировки для сортировки последовательности. ThenBy а ThenByDescending также возвращает значение IOrderedEnumerable<TElement>, что означает любое количество последовательных вызовов к ThenBy или ThenByDescending .

Примечание

Так как IOrderedEnumerable<TElement> наследуется от IEnumerable<T>, можно вызвать OrderBy или OrderByDescending в результатах вызова OrderBy, OrderByDescendingThenBy или ThenByDescending. Это позволяет создать новый первичный порядок, который игнорирует ранее установленный порядок.

Если comparer имеет значение null, для сравнения ключей используется компаратор Default по умолчанию.

Этот метод выполняет стабильную сортировку; То есть, если ключи двух элементов равны, порядок элементов сохраняется. Напротив, нестабильная сортировка не сохраняет порядок элементов с одинаковым ключом.

См. также раздел

• OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)