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.
Assembly: System.Core (in System.Core.dll)
static member GroupJoin<'TOuter, 'TInner, 'TKey, 'TResult> : outer:IEnumerable<'TOuter> * inner:IEnumerable<'TInner> * outerKeySelector:Func<'TOuter, 'TKey> * innerKeySelector:Func<'TInner, 'TKey> * resultSelector:Func<'TOuter, IEnumerable<'TInner>, 'TResult> -> IEnumerable<'TResult>
The first sequence to join.
The sequence to join to the first sequence.
A function to extract the join key from each element of the first sequence.
A function to extract the join key from each element of the second sequence.
Return ValueType: 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.
The type of the elements of the first sequence.
The type of the elements of the second sequence.
The type of the keys returned by the key selector functions.
The type of the result elements.
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.
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.
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.
In query expression syntax, a join … into (Visual C#) or Group Join (Visual Basic) clause translates to an invocation of.
Available since 8
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 8.1