Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
  • None
User Action:
  • None

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

 

Correlates the elements of two sequences based on equality of keys and groups the results. The default equality comparer is used to compare keys.

Namespace:   System.Linq
Assembly:  System.Core (in System.Core.dll)

<ExtensionAttribute>
Public Shared Function GroupJoin(Of TOuter, TInner, TKey, TResult) (
	outer As IEnumerable(Of TOuter),
	inner As IEnumerable(Of TInner),
	outerKeySelector As Func(Of TOuter, TKey),
	innerKeySelector As Func(Of TInner, TKey),
	resultSelector As Func(Of TOuter, IEnumerable(Of TInner), TResult)
) As IEnumerable(Of TResult)

Parameters

outer
Type: System.Collections.Generic.IEnumerable<TOuter>

The first sequence to join.

inner
Type: System.Collections.Generic.IEnumerable<TInner>

The sequence to join to the first sequence.

outerKeySelector
Type: System.Func<TOuter, TKey>

A function to extract the join key from each element of the first sequence.

innerKeySelector
Type: System.Func<TInner, TKey>

A function to extract the join key from each element of the second sequence.

resultSelector
Type: System.Func<TOuter, IEnumerable<TInner>, TResult>

A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence.

Return Value

Type: System.Collections.Generic.IEnumerable<TResult>

An IEnumerable<T> that contains elements of type TResult that are obtained by performing a grouped join on two sequences.

Type Parameters

TOuter

The type of the elements of the first sequence.

TInner

The type of the elements of the second sequence.

TKey

The type of the keys returned by the key selector functions.

TResult

The type of the result elements.

Exception Condition
ArgumentNullException

outer or inner or outerKeySelector or innerKeySelector or resultSelector 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. 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.

The default equality comparer, Default, is used to hash and compare keys.

GroupJoin<TOuter, TInner, TKey, TResult> produces hierarchical results, which means that elements from outer are paired with collections of matching elements from inner. GroupJoin enables you to base your results on a whole set of matches for each element of outer.

System_CAPS_note Note

If there are no correlated elements in inner for a given element of outer, the sequence of matches for that element will be empty but will still appear in the results.

The resultSelector function is called only one time for each outer element together with a collection of all the inner elements that match the outer element. This differs from the Join<TOuter, TInner, TKey, TResult> method, in which the result selector function is invoked on pairs that contain one element from outer and one element from inner.

GroupJoin preserves the order of the elements of outer, and for each element of outer, the order of the matching elements from inner.

GroupJoin<TOuter, TInner, TKey, TResult> has no direct equivalent in traditional relational database terms. However, this method does implement a superset of inner joins and left outer joins. Both of these operations can be written in terms of a grouped join. See Join Operations.

In query expression syntax, a join … into (Visual C#) or Group Join (Visual Basic) clause translates to an invocation of GroupJoin<TOuter, TInner, TKey, TResult>.

The following code example demonstrates how to use GroupJoin<TOuter, TInner, TKey, TResult>(IEnumerable<TOuter>, IEnumerable<TInner>, Func<TOuter, TKey>, Func<TInner, TKey>, Func<TOuter, IEnumerable<TInner>, TResult>) to perform a grouped join on two sequences.

Structure Person
    Public Name As String
End Structure

Structure Pet
    Public Name As String
    Public Owner As Person
End Structure

Sub GroupJoinEx1()
    Dim magnus As New Person With {.Name = "Hedlund, Magnus"}
    Dim terry As New Person With {.Name = "Adams, Terry"}
    Dim charlotte As New Person With {.Name = "Weiss, Charlotte"}

    Dim barley As New Pet With {.Name = "Barley", .Owner = terry}
    Dim boots As New Pet With {.Name = "Boots", .Owner = terry}
    Dim whiskers As New Pet With {.Name = "Whiskers", .Owner = charlotte}
    Dim daisy As New Pet With {.Name = "Daisy", .Owner = magnus}

    Dim people As New List(Of Person)(New Person() {magnus, terry, charlotte})
    Dim pets As New List(Of Pet)(New Pet() {barley, boots, whiskers, daisy})

    ' Create a collection where each element is an anonymous type
    ' that contains a Person's name and a collection of names of 
    ' the pets that are owned by them.
    Dim query = _
        people.GroupJoin(pets, _
                   Function(person) person, _
                   Function(pet) pet.Owner, _
                   Function(person, petCollection) _
                       New With {.OwnerName = person.Name, _
                                 .Pets = petCollection.Select( _
                                                    Function(pet) pet.Name)})

    Dim output As New System.Text.StringBuilder
    For Each obj In query
        ' Output the owner's name.
        output.AppendLine(obj.OwnerName & ":")
        ' Output each of the owner's pet's names.
        For Each pet As String In obj.Pets
            output.AppendLine("  " & pet)
        Next
    Next

    ' Display the output.
    MsgBox(output.ToString)
End Sub

' This code produces the following output:
'
' Hedlund, Magnus
'   Daisy
' Adams, Terry
'   Barley
'   Boots
' Weiss, Charlotte
'   Whiskers

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top