XEnumerableMaxTSource Method

Returns the maximum element of the sequence according to the specified comparer.

Namespace: Linq.Extras
Assembly: Linq.Extras (in Linq.Extras.dll) Version: 5.0.0+96a4f4bfed64095342c5df107c1fe1fb95603ee5

Syntax

Copy

public static TSource Max<TSource>(
	this IEnumerable<TSource> source,
	IComparer<TSource> comparer
)

<ExtensionAttribute>
Public Shared Function Max(Of TSource) ( 
	source As IEnumerable(Of TSource),
	comparer As IComparer(Of TSource)
) As TSource

[<ExtensionAttribute>]
static member Max : 
        source : IEnumerable<'TSource> * 
        comparer : IComparer<'TSource> -> 'TSource

Parameters

source: Type: System.Collections.GenericIEnumerableTSource
The sequence to return the maximum element from.
comparer: Type: System.Collections.GenericIComparerTSource
The comparer used to compare elements.

Type Parameters

TSource: The type of the elements of source.

Return Value

Type: TSource
The maximum element according to the specified comparer.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableTSource. 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).

Remarks

If TSource is a reference type or nullable value type, null values are ignored, unless the sequence consists entirely of null values (in which case the method will return null). If TSource is a reference type or nullable value type, and the sequence is empty, the method will return null. If TSource is a value type, and the sequence is empty, the method will throw an InvalidOperationException.

Reference

XEnumerable Class