Enumerable.Max<TSource> Method (IEnumerable<TSource>, Func<TSource, Nullable<Int32>>)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Invokes a transform function on each element of a sequence and returns the maximum nullable Int32 value.
Namespace: System.Linq
Assembly: System.Core (in System.Core.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function Max(Of TSource) ( _
source As IEnumerable(Of TSource), _
selector As Func(Of TSource, Nullable(Of Integer)) _
) As Nullable(Of Integer)
public static Nullable<int> Max<TSource>(
this IEnumerable<TSource> source,
Func<TSource, Nullable<int>> selector
)
Type Parameters
- TSource
The type of the elements of source.
Parameters
- source
Type: System.Collections.Generic.IEnumerable<TSource>
A sequence of values to determine the maximum value of.
- selector
Type: System.Func<TSource, Nullable<Int32>>
A transform function to apply to each element.
Return Value
Type: System.Nullable<Int32>
The value of type Nullable<Int32> in C# or Nullable(Of Int32) in Visual Basic that corresponds to the maximum value in the sequence.
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.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | source or selector is nulla null reference (Nothing in Visual Basic). |
Remarks
The Max<TSource>(IEnumerable<TSource>, Func<TSource, Nullable<Int32>>) method uses the Int32 implementation of IComparable<T> to compare values.
You can apply this method to a sequence of arbitrary values if you provide a function, selector, that projects the members of source into a numeric type, specifically Nullable<Int32> in C# or Nullable(Of Int32) in Visual Basic.
In Visual Basic query expression syntax, an Aggregate Into Max() clause translates to an invocation of Max.
Examples
The following code example demonstrates how to use Max<TSource>(IEnumerable<TSource>, Func<TSource, Int32>) to determine the maximum value in a sequence of projected values.
Note: |
---|
This code example uses an overload of this overloaded method that is different from the specific overload that this topic describes. To extend the example to this topic, change the body of the selector function. |
Structure Pet
Public Name As String
Public Age As Integer
End Structure
Sub MaxEx4()
' Create an array of Pet objects.
Dim pets() As Pet = {New Pet With {.Name = "Barley", .Age = 8}, _
New Pet With {.Name = "Boots", .Age = 4}, _
New Pet With {.Name = "Whiskers", .Age = 1}}
' Determine the "maximum" pet by passing a
' lambda expression to Max() that sums the pet's age
' and name length.
Dim max As Integer = pets.Max(Function(pet) _
pet.Age + pet.Name.Length)
' Display the result.
outputBlock.Text &= "The maximum pet age plus name length is " & max & vbCrLf
End Sub
' This code produces the following output:
'
' The maximum pet age plus name length is 14
class Pet
{
public string Name { get; set; }
public int Age { get; set; }
}
public static void MaxEx4()
{
Pet[] pets = { new Pet { Name="Barley", Age=8 },
new Pet { Name="Boots", Age=4 },
new Pet { Name="Whiskers", Age=1 } };
int max = pets.Max(pet => pet.Age + pet.Name.Length);
outputBlock.Text += String.Format(
"The maximum pet age plus name length is {0}.",
max) + "\n";
}
/*
This code produces the following output:
The maximum pet age plus name length is 14.
*/
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.