Queryable.OrderByDescending メソッド

定義

名前空間:

System.Linq

アセンブリ:

System.Linq.Queryable.dll

シーケンスの要素を降順に並べ替えます。

オーバーロード

OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)	指定された比較子を使用してシーケンスの要素を降順に並べ替えます。
OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)	シーケンスの要素をキーに従って降順に並べ替えます。

OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>)

ソース:

Queryable.cs

指定された比較子を使用してシーケンスの要素を降順に並べ替えます。

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedQueryable<TSource> ^ OrderByDescending(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, TKey> ^> ^ keySelector, System::Collections::Generic::IComparer<TKey> ^ comparer);

public static System.Linq.IOrderedQueryable<TSource> OrderByDescending<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector, System.Collections.Generic.IComparer<TKey>? comparer);

static member OrderByDescending : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, 'Key>> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedQueryable<'Source>

<Extension()>
Public Function OrderByDescending(Of TSource, TKey) (source As IQueryable(Of TSource), keySelector As Expression(Of Func(Of TSource, TKey)), comparer As IComparer(Of TKey)) As IOrderedQueryable(Of TSource)

型パラメーター

TSource

source の要素の型。

TKey

keySelector で表される関数によって返されるキーの型。

パラメーター

source

IQueryable<TSource>

順序付ける値のシーケンス。

keySelector

Expression<Func<TSource,TKey>>

要素からキーを抽出する関数。

comparer

IComparer<TKey>

キーを比較する IComparer<T>。

戻り値

IOrderedQueryable<TSource>

要素がキーに従って降順に並べ替えられている IOrderedQueryable<T>。

例外

ArgumentNullException

source、keySelector、または comparer は、null です。

例

次のコード例では、 を使用して、カスタム比較子を使用 OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) してシーケンスの要素を降順に並べ替える方法を示します。

/// <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 };

    // Sort the decimal values in descending order
    // by using a custom comparer.
    IEnumerable<decimal> query =
        decimals.AsQueryable()
        .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
*/

''' <summary>
''' This class provides a custom implementation of the
''' IComparer.Compare() method. It sorts by the fractional part of the decimal number.
''' </summary>
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.AsQueryable(). _
        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

注釈

このメソッドには、型引数が型 Expression<TDelegate> の 1 つである型のパラメーターが少なくとも 1 つ Func<T,TResult> 含まれています。 これらのパラメーターでは、ラムダ式を渡すと、 に Expression<TDelegate>コンパイルされます。

メソッドは OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) 、 MethodCallExpression 構築されたジェネリック メソッドとしての呼び出し OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) 自体を表す を生成します。 次に、 パラメーターの MethodCallExpressionCreateQuery<TElement>(Expression) プロパティで表される の IQueryProvider メソッドに をProvidersource渡します。 を呼び出した CreateQuery<TElement>(Expression) 結果は 型 IOrderedQueryable<T> にキャストされ、返されます。

呼び出し OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>, IComparer<TKey>) を表す式ツリーを実行した結果として発生するクエリ動作は、 パラメーターの型の source 実装によって異なります。 予期される動作は、 のsource各要素で を呼び出すことによって取得されたキーに基づいて、 の要素sourceをkeySelector降順に並べ替えることです。 パラメーターは comparer 、キーを比較するために使用されます。

OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>)

ソース:

Queryable.cs

シーケンスの要素をキーに従って降順に並べ替えます。

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedQueryable<TSource> ^ OrderByDescending(System::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, TKey> ^> ^ keySelector);

public static System.Linq.IOrderedQueryable<TSource> OrderByDescending<TSource,TKey> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,TKey>> keySelector);

static member OrderByDescending : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, 'Key>> -> System.Linq.IOrderedQueryable<'Source>

<Extension()>
Public Function OrderByDescending(Of TSource, TKey) (source As IQueryable(Of TSource), keySelector As Expression(Of Func(Of TSource, TKey))) As IOrderedQueryable(Of TSource)

型パラメーター

TSource

source の要素の型。

TKey

keySelector で表される関数によって返されるキーの型。

パラメーター

source

IQueryable<TSource>

順序付ける値のシーケンス。

keySelector

Expression<Func<TSource,TKey>>

要素からキーを抽出する関数。

戻り値

IOrderedQueryable<TSource>

要素がキーに従って降順に並べ替えられている IOrderedQueryable<T>。

例外

ArgumentNullException

source または keySelector が null です。

注釈

このメソッドには、型引数が型 Expression<TDelegate> の 1 つである型のパラメーターが少なくとも 1 つ Func<T,TResult> 含まれています。 これらのパラメーターでは、ラムダ式を渡すと、 に Expression<TDelegate>コンパイルされます。

メソッドは OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) 、 MethodCallExpression 構築されたジェネリック メソッドとしての呼び出し OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) 自体を表す を生成します。 次に、 パラメーターの MethodCallExpressionCreateQuery<TElement>(Expression) プロパティで表される の IQueryProvider メソッドに をProvidersource渡します。 を呼び出した CreateQuery<TElement>(Expression) 結果は 型 IOrderedQueryable<T> にキャストされ、返されます。

呼び出し OrderByDescending<TSource,TKey>(IQueryable<TSource>, Expression<Func<TSource,TKey>>) を表す式ツリーを実行した結果として発生するクエリ動作は、 パラメーターの型の source 実装によって異なります。 予期される動作は、 のsource各要素で を呼び出すことによって取得されたキーに基づいて、 の要素sourceをkeySelector降順に並べ替えることです。