EnumerableExt.MaxBy(TSource, TKey) Method (IEnumerable(TSource), Func(TSource, TKey), IComparer(TKey))
Returns the maximal element of the given sequence, based on the given projection and the specified comparer for projected values.
Namespace: UltimateXR.Extensions.System.Collections
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
public static TSource MaxBy<TSource, TKey>(
this IEnumerable<TSource> source,
Func<TSource, TKey> selector,
IComparer<TKey> comparer
)
Parameters
- source
- Type: System.Collections.Generic.IEnumerable(TSource)
Source sequence - selector
- Type: System.Func(TSource, TKey)
Selector to use to pick the results to compare - comparer
- Type: System.Collections.Generic.IComparer(TKey)
Comparer to use to compare projected values
Type Parameters
- TSource
- Type of the source sequence
- TKey
- Type of the projected element
Return Value
Type: TSource
The maximal element, according to the projection.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(TSource). 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).
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | source, selector or comparer is null |
Exception | A delegate callback throws an exception. |
Remarks
This operator uses deferred execution. The results are evaluated and cached on first use to returned sequence.
See Also
Reference
EnumerableExt Class
MaxBy Overload
UltimateXR.Extensions.System.Collections Namespace