Enumerable.OrderBy メソッド

ソース:

OrderBy.cs

ソース:

OrderBy.cs

ソース:

OrderBy.cs

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)

型パラメーター

パラメーター

戻り値

要素がキーに従って並べ替えられている IOrderedEnumerable<TElement>。

例外

例

次のコード例は、 を使用 OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) してシーケンスの要素を並べ替える方法を示しています。

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

注釈

このメソッドは、遅延実行を使用して実装されます。 即時戻り値は、アクションの実行に必要なすべての情報を格納する オブジェクトです。 このメソッドで表されるクエリは、オブジェクトがメソッドを直接呼び出GetEnumeratorすか、C# または For Each Visual Basic で を使用foreachして列挙されるまで実行されません。

要素自体の値でシーケンスを並べ替える場合は、 に ID 関数 (x => x C# または Function(x) x Visual Basic では ) を keySelector指定します。

型を拡張 IOrderedEnumerable<TElement>する 2 つのメソッドが定義されています。これは、このメソッドの戻り値の型です。 これら 2 つのメソッド (つまり ThenBy 、 と ThenByDescending) を使用すると、シーケンスを並べ替える追加の並べ替え条件を指定できます。 ThenByと ThenByDescending は、 IOrderedEnumerable<TElement>を返します。これは、 または ThenByDescending に対して任意の数の連続する呼び出しをThenBy行うことができるを意味します。

このメソッドは、既定の比較子 Defaultを使用してキーを比較します。

このメソッドは、安定した並べ替えを実行します。つまり、2 つの要素のキーが等しい場合、要素の順序は保持されます。 一方、不安定な並べ替えでは、同じキーを持つ要素の順序は保持されません。

クエリ式の構文では、 orderby (C#) 句または Order By (Visual Basic) 句が の OrderBy呼び出しに変換されます。

こちらもご覧ください

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)
• orderby 句 (C# リファレンス)
• Order By 句 (Visual Basic)

ソース:

OrderBy.cs

ソース:

OrderBy.cs

ソース:

OrderBy.cs

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

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)

型パラメーター

パラメーター

戻り値

要素がキーに従って並べ替えられている IOrderedEnumerable<TElement>。

例外

注釈

このメソッドは、遅延実行を使用して実装されます。 即時戻り値は、アクションの実行に必要なすべての情報を格納する オブジェクトです。 このメソッドで表されるクエリは、オブジェクトがメソッドを直接呼び出GetEnumeratorすか、C# または For Each Visual Basic で を使用foreachして列挙されるまで実行されません。

要素自体の値でシーケンスを並べ替える場合は、 に ID 関数 (x => x C# または Function(x) x Visual Basic では ) を keySelector指定します。

型を拡張 IOrderedEnumerable<TElement>する 2 つのメソッドが定義されています。これは、このメソッドの戻り値の型です。 これら 2 つのメソッド (つまり ThenBy 、 と ThenByDescending) を使用すると、シーケンスを並べ替える追加の並べ替え条件を指定できます。 ThenByと ThenByDescending は、 IOrderedEnumerable<TElement>を返します。これは、 または ThenByDescending に対して任意の数の連続する呼び出しをThenBy行うことができるを意味します。

が のnull場合comparer、既定の比較子Defaultを使用してキーが比較されます。

このメソッドは、安定した並べ替えを実行します。つまり、2 つの要素のキーが等しい場合、要素の順序は保持されます。 一方、不安定な並べ替えでは、同じキーを持つ要素の順序は保持されません。

こちらもご覧ください

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