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

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Returns the minimum value in a generic sequence.

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

Syntax

<ExtensionAttribute> _
Public Shared Function Min(Of TSource) ( _
    source As IEnumerable(Of TSource) _
) As TSource
public static TSource Min<TSource>(
    this IEnumerable<TSource> source
)

Type Parameters

  • TSource
    The type of the elements of source.

Parameters

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.

Exceptions

Exception Condition
ArgumentNullException

source is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

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 nullNothingnullptra null reference (Nothing in Visual Basic), this function returns nullNothingnullptra null reference (Nothing in Visual Basic).

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

Examples

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.
      outputBlock.Text &= "The 'minimum' pet is " & min.Name & vbCrLf
   End Sub

   ' This code produces the following output:
   '
   ' The 'minimum' pet is Whiskers
      /// <summary>
      /// This class implements IComparable in order to 
      /// be able to compare different Pet objects.
      /// </summary>
      class Pet : IComparable<Pet>
      {
         public string Name { get; set; }
         public int Age { get; set; }

         /// <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>
         int IComparable<Pet>.CompareTo(Pet other)
         {
            if (other.Age > this.Age)
               return -1;
            else if (other.Age == this.Age)
               return 0;
            else
               return 1;
         }
      }

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

         Pet min = pets.Min();

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

      /*
       This code produces the following output:

       The 'minimum' animal is Whiskers.
      */

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

Enumerable Class

Min Overload

System.Linq Namespace