Enumerable.OrderByDescending Méthode

Définition

Trie les éléments d'une séquence dans l'ordre décroissant.

Surcharges

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

Trie les éléments d'une séquence dans l'ordre décroissant selon une clé.

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

Trie les éléments d'une séquence dans l'ordre décroissant à l'aide d'un comparateur spécifié.

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

Trie les éléments d'une séquence dans l'ordre décroissant selon une clé.

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)

Paramètres de type

TSource

Le type des éléments de source.

TKey

Type de clé retournée par keySelector.

Paramètres

source
IEnumerable<TSource>

Séquence de valeurs à classer.

keySelector
Func<TSource,TKey>

Fonction permettant d'extraire une clé d'un élément.

Retours

IOrderedEnumerable<TElement> dont les éléments sont triés dans l'ordre décroissant selon une clé.

Exceptions

source ou keySelector est null.

Remarques

Cette méthode est implémentée à l’aide de l’exécution différée. La valeur de retour immédiat est un objet qui stocke toutes les informations nécessaires à l’exécution de l’action. La requête représentée par cette méthode n’est pas exécutée tant que l’objet n’est pas énuméré soit en appelant directement sa GetEnumerator méthode, soit en utilisant foreach en C# ou For Each en Visual Basic.

Pour classer une séquence en fonction des valeurs des éléments eux-mêmes, spécifiez la fonction d’identité (x => x en C# ou Function(x) x en Visual Basic) pour keySelector.

Pour obtenir un exemple de cette méthode, consultez OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>).

Deux méthodes sont définies pour étendre le type IOrderedEnumerable<TElement>, qui est le type de retour de cette méthode. Ces deux méthodes, à savoir ThenBy et ThenByDescending, vous permettent de spécifier des critères de tri supplémentaires pour trier une séquence. ThenBy et ThenByDescending retournent également un IOrderedEnumerable<TElement>, ce qui signifie que n’importe quel nombre d’appels consécutifs à ThenBy ou ThenByDescending peuvent être effectués.

Notes

Étant donné qu’hérite IOrderedEnumerable<TElement> de IEnumerable<T>, vous pouvez appeler OrderBy ou OrderByDescending sur les résultats d’un appel à OrderBy, OrderByDescendingThenBy ou ThenByDescending. Cela introduit un nouveau classement principal qui ignore le classement établi précédemment.

Cette méthode compare les clés à l’aide du comparateur Defaultpar défaut .

Cette méthode effectue un tri stable ; Autrement dit, si les clés de deux éléments sont égales, l’ordre des éléments est conservé. En revanche, un tri instable ne conserve pas l’ordre des éléments qui ont la même clé.

Dans la syntaxe d’expression de requête, une orderby descending clause (C#) ou Order By Descending (Visual Basic) se traduit par un appel de OrderByDescending.

Voir aussi

S’applique à

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

Trie les éléments d'une séquence dans l'ordre décroissant à l'aide d'un comparateur spécifié.

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

Paramètres de type

TSource

Le type des éléments de source.

TKey

Type de clé retournée par keySelector.

Paramètres

source
IEnumerable<TSource>

Séquence de valeurs à classer.

keySelector
Func<TSource,TKey>

Fonction permettant d'extraire une clé d'un élément.

comparer
IComparer<TKey>

IComparer<T> pour comparer les clés.

Retours

IOrderedEnumerable<TElement> dont les éléments sont triés dans l'ordre décroissant selon une clé.

Exceptions

source ou keySelector est null.

Exemples

L’exemple de code suivant montre comment utiliser OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>) pour trier les éléments d’une séquence dans l’ordre décroissant à l’aide d’une fonction de transformation et d’un comparateur personnalisé.

/// <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.
    Console.WriteLine(output.ToString())
End Sub

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

Remarques

Cette méthode est implémentée à l’aide de l’exécution différée. La valeur de retour immédiat est un objet qui stocke toutes les informations nécessaires à l’exécution de l’action. La requête représentée par cette méthode n’est pas exécutée tant que l’objet n’est pas énuméré soit en appelant directement sa GetEnumerator méthode, soit en utilisant foreach en C# ou For Each en Visual Basic.

Pour classer une séquence en fonction des valeurs des éléments eux-mêmes, spécifiez la fonction d’identité (x => x en C# ou Function(x) x en Visual Basic) pour keySelector.

Deux méthodes sont définies pour étendre le type IOrderedEnumerable<TElement>, qui est le type de retour de cette méthode. Ces deux méthodes, à savoir ThenBy et ThenByDescending, vous permettent de spécifier des critères de tri supplémentaires pour trier une séquence. ThenBy et ThenByDescending retournent également un IOrderedEnumerable<TElement>, ce qui signifie que n’importe quel nombre d’appels consécutifs à ThenBy ou ThenByDescending peuvent être effectués.

Notes

Étant donné qu’hérite IOrderedEnumerable<TElement> de IEnumerable<T>, vous pouvez appeler OrderBy ou OrderByDescending sur les résultats d’un appel à OrderBy, OrderByDescendingThenBy ou ThenByDescending. Cela introduit un nouveau classement principal qui ignore le classement établi précédemment.

Si comparer a la valeur null, le comparateur Default par défaut est utilisé pour comparer les clés.

Cette méthode effectue un tri stable ; Autrement dit, si les clés de deux éléments sont égales, l’ordre des éléments est conservé. En revanche, un tri instable ne conserve pas l’ordre des éléments qui ont la même clé.

Voir aussi

S’applique à