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

Returns the minimum value in a generic sequence.

Namespace:  System.Linq
Assembly:  System.Core (in System.Core.dll)
'Declaration
<ExtensionAttribute> _
Public Shared Function Min(Of TSource) ( _
	source As IEnumerable(Of TSource) _
) As TSource

Type Parameters

TSource

The type of the elements of source.

Parameters

source
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.

Usage Note

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

source is Nothing.

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 Nothing, this function returns Nothing.

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
            Else 
                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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft. All rights reserved.