Enumerable.Min(Of TSource) Method (IEnumerable(Of TSource))


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the minimum value in a generic sequence.

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

Public Shared Function Min(Of TSource) (
	source As IEnumerable(Of TSource)
) As TSource


Type: System.Collections.Generic.IEnumerable(Of TSource)

A sequence of values to determine the minimum value of.

Return Value

Type: TSource

The minimum value in the sequence.

Type Parameters


The type of the elements of source.

Exception Condition

source is null.

If type TSource implements IComparable(Of T), this method uses that implementation to compare values. Otherwise, if type TSource implements IComparable, that implementation is used to compare values.

If TSource is a reference type and the source sequence is empty or contains only values that are null, this function returns null.

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

The following code example demonstrates how to use Min(Of TSource)(IEnumerable(Of TSource)) to determine the minimum value in a sequence of IComparable(Of T) objects.

' This class implements IComparable 
' and has a custom 'CompareTo' implementation.
Class Pet
    Implements IComparable(Of Pet)

    Public Name As String
    Public Age As Integer

    ''' <summary>
    ''' Compares this Pet's age to another Pet's age.
    ''' </summary>
    ''' <param name="other">The Pet to compare this Pet to.</param>
    ''' <returns>-1 if this Pet's age is smaller,
    ''' 0 if the Pets' ages are equal,
    ''' or 1 if this Pet's age is greater.</returns>
    Function CompareTo(ByVal other As Pet) As Integer _
    Implements IComparable(Of Pet).CompareTo

        If (other.Age > Me.Age) Then
            Return -1
        ElseIf (other.Age = Me.Age) Then
            Return 0
            Return 1
        End If
    End Function
End Class

Sub MinEx3()
    ' 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 "minimum" pet in the array,
    ' according to the custom CompareTo() implementation.
    Dim min As Pet = pets.Min()

    ' Display the result.
    MsgBox("The 'minimum' pet is " & min.Name)
End Sub

' This code produces the following output:
' The 'minimum' pet is Whiskers

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top