Enumerable.OrderBy メソッド

定義

シーケンスの要素を昇順に並べ替えます。Sorts the elements of a sequence in ascending order.

オーバーロード

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

シーケンスの要素をキーに従って昇順に並べ替えます。Sorts the elements of a sequence in ascending order according to a key.

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

指定された比較子を使用してシーケンスの要素を昇順に並べ替えます。Sorts the elements of a sequence in ascending order by using a specified comparer.

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

シーケンスの要素をキーに従って昇順に並べ替えます。Sorts the elements of a sequence in ascending order according to a key.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderBy(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector);
public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);
static member OrderBy : seq<'Source> * Func<'Source, 'Key> -> System.Linq.IOrderedEnumerable<'Source>
<Extension()>
Public Function OrderBy(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 according to a key.

例外

source または keySelectornull です。source or keySelector is null.

次のコード例は、OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) を使用してシーケンスの要素を並べ替える方法を示しています。The following code example demonstrates how to use OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) to sort the elements of a sequence.

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void OrderByEx1()
{
    Pet[] pets = { new Pet { Name="Barley", Age=8 },
                   new Pet { Name="Boots", Age=4 },
                   new Pet { Name="Whiskers", Age=1 } };

    IEnumerable<Pet> query = pets.OrderBy(pet => pet.Age);

    foreach (Pet pet in query)
    {
        Console.WriteLine("{0} - {1}", pet.Name, pet.Age);
    }
}

/*
 This code produces the following output:

 Whiskers - 1
 Boots - 4
 Barley - 8
*/
Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Sub OrderByEx1()
    ' Create an array of Pet objects.
    Dim pets() As Pet = {New Pet With {.Name = "Barley", .Age = 8},
                     New Pet With {.Name = "Boots", .Age = 4},
                     New Pet With {.Name = "Whiskers", .Age = 1}}

    ' Order the Pet objects by their Age property.
    Dim query As IEnumerable(Of Pet) =
    pets.OrderBy(Function(pet) pet.Age)

    Dim output As New System.Text.StringBuilder
    For Each pt As Pet In query
        output.AppendLine(pt.Name & " - " & pt.Age)
    Next

    ' Display the output.
    Console.WriteLine(output.ToString())
End Sub

' This code produces the following output:
'
' Whiskers - 1
' Boots - 4
' Barley - 8

注釈

このメソッドは、遅延実行を使用して実装されます。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メソッドを使用して直接またはforeachVisual C# またはFor EachVisual 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) xVisual Basic) のkeySelectorTo 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>型を拡張する2つのメソッドが定義されています。これは、このメソッドの戻り値の型です。Two methods are defined to extend the type IOrderedEnumerable<TElement>, which is the return type of this method. この2つの方法 (つまり ThenByThenByDescending) を使用すると、シーケンスを並べ替えるための追加の並べ替え条件を指定できます。These two methods, namely ThenBy and ThenByDescending, enable you to specify additional sort criteria to sort a sequence. ThenByThenByDescendingIOrderedEnumerable<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>から継承されるため、OrderByOrderByDescendingThenByThenByDescendingの呼び出しの結果に対して OrderBy または OrderByDescending を呼び出すことができます。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.

このメソッドは、安定した並べ替えを実行します。つまり、2つの要素のキーが等しい場合、要素の順序は保持されます。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 (Visual C#) またはOrder Byの呼び出しに変換します (Visual Basic) 句OrderByします。In query expression syntax, an orderby (Visual C#) or Order By (Visual Basic) clause translates to an invocation of OrderBy.

こちらもご覧ください

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

指定された比較子を使用してシーケンスの要素を昇順に並べ替えます。Sorts the elements of a sequence in ascending order by using a specified comparer.

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderBy(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector, System::Collections::Generic::IComparer<TKey> ^ comparer);
public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector, System.Collections.Generic.IComparer<TKey> comparer);
static member OrderBy : seq<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedEnumerable<'Source>
<Extension()>
Public Function OrderBy(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 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メソッドを使用して直接またはforeachVisual C# またはFor EachVisual 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) xVisual Basic) のkeySelectorTo 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>型を拡張する2つのメソッドが定義されています。これは、このメソッドの戻り値の型です。Two methods are defined to extend the type IOrderedEnumerable<TElement>, which is the return type of this method. この2つの方法 (つまり ThenByThenByDescending) を使用すると、シーケンスを並べ替えるための追加の並べ替え条件を指定できます。These two methods, namely ThenBy and ThenByDescending, enable you to specify additional sort criteria to sort a sequence. ThenByThenByDescendingIOrderedEnumerable<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>から継承されるため、OrderByOrderByDescendingThenByThenByDescendingの呼び出しの結果に対して OrderBy または OrderByDescending を呼び出すことができます。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.

comparernull場合、既定の比較子 Default を使用してキーを比較します。If comparer is null, the default comparer Default is used to compare keys.

このメソッドは、安定した並べ替えを実行します。つまり、2つの要素のキーが等しい場合、要素の順序は保持されます。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.

こちらもご覧ください

適用対象