Enumerable.GroupJoin メソッド

定義

名前空間:

System.Linq

アセンブリ:

System.Linq.dll

キーの等価性に基づいて 2 つのシーケンスの要素を関連付け、結果をグループ化します。

オーバーロード

GroupJoin<TOuter,TInner,TKey,TResult>(IEnumerable<TOuter>, IEnumerable<TInner>, Func<TOuter,TKey>, Func<TInner,TKey>, Func<TOuter,IEnumerable<TInner>, TResult>)	キーの等価性に基づいて 2 つのシーケンスの要素を関連付け、結果をグループ化します。 キーの比較には、既定の等値比較子が使用されます。
GroupJoin<TOuter,TInner,TKey,TResult>(IEnumerable<TOuter>, IEnumerable<TInner>, Func<TOuter,TKey>, Func<TInner,TKey>, Func<TOuter,IEnumerable<TInner>, TResult>, IEqualityComparer<TKey>)	キーの等価性に基づいて 2 つのシーケンスの要素を関連付け、結果をグループ化します。 キーの比較には、指定した IEqualityComparer<T> が使用されます。

GroupJoin<TOuter,TInner,TKey,TResult>(IEnumerable<TOuter>, IEnumerable<TInner>, Func<TOuter,TKey>, Func<TInner,TKey>, Func<TOuter,IEnumerable<TInner>, TResult>)

ソース:

GroupJoin.cs

キーの等価性に基づいて 2 つのシーケンスの要素を関連付け、結果をグループ化します。 キーの比較には、既定の等値比較子が使用されます。

C#

public static System.Collections.Generic.IEnumerable<TResult> GroupJoin<TOuter,TInner,TKey,TResult> (this System.Collections.Generic.IEnumerable<TOuter> outer, System.Collections.Generic.IEnumerable<TInner> inner, Func<TOuter,TKey> outerKeySelector, Func<TInner,TKey> innerKeySelector, Func<TOuter,System.Collections.Generic.IEnumerable<TInner>,TResult> resultSelector);

型パラメーター

TOuter

最初のシーケンスの要素の型。

TInner

2 番目のシーケンスの要素の型。

TKey

キー セレクター関数によって返されるキーの型。

TResult

結果要素の型。

パラメーター

outer

IEnumerable<TOuter>

結合する最初のシーケンス。

inner

IEnumerable<TInner>

最初のシーケンスに結合するシーケンス。

outerKeySelector

Func<TOuter,TKey>

最初のシーケンスの各要素から結合キーを抽出する関数。

innerKeySelector

Func<TInner,TKey>

2 番目のシーケンスの各要素から結合キーを抽出する関数。

resultSelector

Func<TOuter,IEnumerable<TInner>,TResult>

最初のシーケンスの要素から結果要素を作成し、2 番目のシーケンスから一致する要素のコレクションを作成する関数。

戻り値

IEnumerable<TResult>

2 つのシーケンスでグループ化結合を実行することによって取得される TResult 型の要素を含む IEnumerable<T>。

例外

ArgumentNullException

outer、inner、outerKeySelector、innerKeySelector、または resultSelector が null。

例

次のコード例では、GroupJoin<TOuter,TInner,TKey,TResult>(IEnumerable<TOuter>, IEnumerable<TInner>, Func<TOuter,TKey>, Func<TInner,TKey>, Func<TOuter,IEnumerable<TInner>, TResult>) を使用して 2 つのシーケンスでグループ化結合を実行する方法を示します。

C#

class Person
{
    public string Name { get; set; }
}

class Pet
{
    public string Name { get; set; }
    public Person Owner { get; set; }
}

public static void GroupJoinEx1()
{
    Person magnus = new Person { Name = "Hedlund, Magnus" };
    Person terry = new Person { Name = "Adams, Terry" };
    Person charlotte = new Person { Name = "Weiss, Charlotte" };

    Pet barley = new Pet { Name = "Barley", Owner = terry };
    Pet boots = new Pet { Name = "Boots", Owner = terry };
    Pet whiskers = new Pet { Name = "Whiskers", Owner = charlotte };
    Pet daisy = new Pet { Name = "Daisy", Owner = magnus };

    List<Person> people = new List<Person> { magnus, terry, charlotte };
    List<Pet> pets = new List<Pet> { barley, boots, whiskers, daisy };

    // Create a list where each element is an anonymous
    // type that contains a person's name and
    // a collection of names of the pets they own.
    var query =
        people.GroupJoin(pets,
                         person => person,
                         pet => pet.Owner,
                         (person, petCollection) =>
                             new
                             {
                                 OwnerName = person.Name,
                                 Pets = petCollection.Select(pet => pet.Name)
                             });

    foreach (var obj in query)
    {
        // Output the owner's name.
        Console.WriteLine("{0}:", obj.OwnerName);
        // Output each of the owner's pet's names.
        foreach (string pet in obj.Pets)
        {
            Console.WriteLine("  {0}", pet);
        }
    }
}

/*
 This code produces the following output:

 Hedlund, Magnus:
   Daisy
 Adams, Terry:
   Barley
   Boots
 Weiss, Charlotte:
   Whiskers
*/

注釈

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

既定の等値比較子 (Default) は、キーのハッシュと比較に使用されます。

GroupJoin は階層的な結果を生成します。つまり、outer の要素は、innerの一致する要素のコレクションとペアになります。 GroupJoin を使用すると、outerの各要素の一致のセット全体に基づいて結果を作成できます。

注意

outerの特定の要素に対して inner に関連付けられた要素がない場合、その要素の一致のシーケンスは空になりますが、結果には引き続き表示されます。

resultSelector 関数は、outer 要素ごとに 1 回だけ呼び出され、outer 要素と一致するすべての inner 要素のコレクションが呼び出されます。 これは、Join メソッドとは異なり、結果セレクター関数は、outer の 1 つの要素と innerの 1 つの要素を含むペアで呼び出されます。

GroupJoin は、outerの要素の順序を保持し、outerの各要素に対して、innerからの一致する要素の順序を保持します。

GroupJoin には、従来のリレーショナル データベースの用語に直接相当するものはありません。 ただし、このメソッドは内部結合と左外部結合のスーパーセットを実装します。 これらの操作はどちらも、グループ化結合の観点から記述できます。 詳細については、「結合操作」を参照してください。

クエリ式の構文では、join ... into (C#) 句または Group Join (Visual Basic) 句が GroupJoinの呼び出しに変換されます。

こちらもご覧ください

• 結合操作 (C#)
• 結合操作 (Visual Basic)
• join 句 (C# リファレンス)
• グループ結合句 (Visual Basic)

GroupJoin<TOuter,TInner,TKey,TResult>(IEnumerable<TOuter>, IEnumerable<TInner>, Func<TOuter,TKey>, Func<TInner,TKey>, Func<TOuter,IEnumerable<TInner>, TResult>, IEqualityComparer<TKey>)

ソース:

GroupJoin.cs

キーの等価性に基づいて 2 つのシーケンスの要素を関連付け、結果をグループ化します。 キーの比較には、指定した IEqualityComparer<T> が使用されます。

C#

public static System.Collections.Generic.IEnumerable<TResult> GroupJoin<TOuter,TInner,TKey,TResult> (this System.Collections.Generic.IEnumerable<TOuter> outer, System.Collections.Generic.IEnumerable<TInner> inner, Func<TOuter,TKey> outerKeySelector, Func<TInner,TKey> innerKeySelector, Func<TOuter,System.Collections.Generic.IEnumerable<TInner>,TResult> resultSelector, System.Collections.Generic.IEqualityComparer<TKey>? comparer);

型パラメーター

TOuter

最初のシーケンスの要素の型。

TInner

2 番目のシーケンスの要素の型。

TKey

キー セレクター関数によって返されるキーの型。

TResult

結果要素の型。

パラメーター

outer

IEnumerable<TOuter>

結合する最初のシーケンス。

inner

IEnumerable<TInner>

最初のシーケンスに結合するシーケンス。

outerKeySelector

Func<TOuter,TKey>

最初のシーケンスの各要素から結合キーを抽出する関数。

innerKeySelector

Func<TInner,TKey>

2 番目のシーケンスの各要素から結合キーを抽出する関数。

resultSelector

Func<TOuter,IEnumerable<TInner>,TResult>

最初のシーケンスの要素から結果要素を作成し、2 番目のシーケンスから一致する要素のコレクションを作成する関数。

comparer

IEqualityComparer<TKey>

キーのハッシュと比較を行う IEqualityComparer<T>。

戻り値

IEnumerable<TResult>

2 つのシーケンスでグループ化結合を実行することによって取得される TResult 型の要素を含む IEnumerable<T>。

例外

ArgumentNullException

outer、inner、outerKeySelector、innerKeySelector、または resultSelector が null。

注釈

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

comparer が nullの場合、キーのハッシュと比較には、既定の等値比較子 (Default) が使用されます。

GroupJoin は階層的な結果を生成します。つまり、outer の要素は、innerの一致する要素のコレクションとペアになります。 GroupJoin を使用すると、outerの各要素の一致のセット全体に基づいて結果を作成できます。

注意

outerの特定の要素に対して inner に関連付けられた要素がない場合、その要素の一致のシーケンスは空になりますが、結果には引き続き表示されます。

resultSelector 関数は、outer 要素ごとに 1 回だけ呼び出され、outer 要素と一致するすべての inner 要素のコレクションが呼び出されます。 これは、outer の 1 つの要素と innerの 1 つの要素を含むペアで結果セレクター関数が呼び出される Join メソッドとは異なります。

GroupJoin は、outerの要素の順序を保持し、outerの各要素に対して、innerからの一致する要素の順序を保持します。

GroupJoin には、従来のリレーショナル データベースの用語に直接相当するものはありません。 ただし、このメソッドは内部結合と左外部結合のスーパーセットを実装します。 これらの操作はどちらも、グループ化結合の観点から記述できます。 詳細については、「結合操作」を参照してください。

こちらもご覧ください

• 結合操作 (C#)
• 結合操作 (Visual Basic)