Enumerable.GroupBy(TSource, TKey, TElement) Method (IEnumerable(TSource), Func(TSource, TKey), Func(TSource, TElement), IEqualityComparer(TKey))
Groups the elements of a sequence according to a key selector function. The keys are compared by using a comparer and each group's elements are projected by using a specified function.
Assemblies: System.Linq (in System.Linq.dll)
System.Core (in System.Core.dll)
static member GroupBy : source:IEnumerable<'TSource> * keySelector:Func<'TSource, 'TKey> * elementSelector:Func<'TSource, 'TElement> * comparer:IEqualityComparer<'TKey> -> IEnumerable<IGrouping<'TKey, 'TElement>>
The type of the elements of source.
The type of the key returned by keySelector.
The type of the elements in the IGrouping(TKey, TElement).
- Type: System.Func(, )
A function to extract the key for each element.
- Type: System.Func(, )
A function to map each source element to an element in an IGrouping(TKey, TElement).
Return ValueType: System.Collections.Generic.IEnumerable(IGrouping(, ))
An IEnumerable<IGrouping<TKey, TElement>> in C# or IEnumerable(Of IGrouping(Of TKey, TElement)) in Visual Basic where each IGrouping(TKey, TElement) object contains a collection of objects of type TElement and a key.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(). When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
source or keySelector or elementSelector is a null reference (Nothing in Visual Basic).
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.
For examples of GroupBy, see the following topics.
The method returns a collection of IGrouping(TKey, TElement) objects, one for each distinct key that was encountered. An IGrouping(TKey, TElement) is an IEnumerable(T) that also has a key associated with its elements.
The IGrouping(TKey, TElement) objects are yielded in an order based on the order of the elements in source that produced the first key of each IGrouping(TKey, TElement). Elements in a grouping are yielded in the order that the elements that produced them appear in source.
If comparer is a null reference (Nothing in Visual Basic), the default equality comparer Default is used to compare keys.
If two keys are considered equal according to comparer, the first key is chosen as the key for that grouping.
In query expression syntax, a group by (Visual C#) or Group By Into (Visual Basic) clause translates to an invocation of GroupBy. For more information and usage examples, see group clause (C# Reference) and Group By Clause (Visual Basic).