Article
11/17/2011

Enumerable.Min<TSource, TResult> Method (IEnumerable<TSource>, Func<TSource, TResult>)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Invokes a transform function on each element of a generic sequence and returns the minimum resulting value.

Namespace: System.Linq
Assembly: System.Core (in System.Core.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Min(Of TSource, TResult) ( _
    source As IEnumerable(Of TSource), _
    selector As Func(Of TSource, TResult) _
) As TResult

public static TResult Min<TSource, TResult>(
    this IEnumerable<TSource> source,
    Func<TSource, TResult> selector
)

Type Parameters

TSource
The type of the elements of source.

TResult
The type of the value returned by selector.

Parameters

source
Type: System.Collections.Generic.IEnumerable<TSource>
A sequence of values to determine the minimum value of.

selector
Type: System.Func<TSource, TResult>
A transform function to apply to each element.

Return Value

Type: TResult
The minimum 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

If type TResult implements IComparable<T>, this method uses that implementation to compare values. Otherwise, if type TResult implements IComparable, that implementation is used to compare values.

In Visual Basic query expression syntax, an Aggregate Into Min() clause translates to an invocation of Min.

Examples

The following code example demonstrates how to use Min<TSource>(IEnumerable<TSource>, Func<TSource, Int32>) to determine the minimum 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 MinEx4()
      ' 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}}

      ' Find the youngest pet by passing a 
      ' lambda expression to the Min() method.
      Dim min As Integer = pets.Min(Function(pet) pet.Age)

      ' Display the result.
      outputBlock.Text &= "The youngest pet is age " & min & vbCrLf
   End Sub

   ' This code produces the following output:
   '
   ' The youngest pet is age 1

      class Pet
      {
         public string Name { get; set; }
         public int Age { get; set; }
      }

      public static void MinEx4()
      {
         Pet[] pets = { new Pet { Name="Barley", Age=8 },
                            new Pet { Name="Boots", Age=4 },
                            new Pet { Name="Whiskers", Age=1 } };

         int min = pets.Min(pet => pet.Age);

         outputBlock.Text += String.Format("The youngest animal is age {0}.", min) + "\n";
      }

      /*
       This code produces the following output:

       The youngest animal is age 1.  
      */

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.

Share via