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

  • Article

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

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

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

Syntax

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

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

Type Parameters

  • TSource
    The type of the elements of source.

Parameters

  • selector
    Type: System..::.Func<(Of <(TSource, Double>)>)
    A transform function to apply to each element.

Return Value

Type: System..::.Double
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 or selector is nullNothingnullptra null reference (Nothing in Visual Basic).
InvalidOperationException

source contains no elements.

Remarks

The Min<(Of <(TSource>)>)(IEnumerable<(Of <(TSource>)>), Func<(Of <(TSource, Double>)>)) method uses the Double implementation of IComparable<(Of <(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 Double.

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>)>), Func<(Of <(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

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