List.min<'T> Function (F#)

  • Article

Returns the lowest of all elements of the list, compared by using Operators.min.

Namespace/Module Path: Microsoft.FSharp.Collections.List

Assembly: FSharp.Core (in FSharp.Core.dll)

// Signature:
List.min : 'T list -> 'T (requires comparison)

// Usage:
List.min list

Parameters

  • list
    Type: 'Tlist

    The input list.

Exceptions

Exception

Condition

ArgumentException

Thrown when the list is empty.

Return Value

The minimum value.

Remarks

This function is named Min in compiled assemblies. If you are accessing the function from a .NET language other than F#, or through reflection, use this name.

Example

The following code shows how to use List.min.

[ for x in -100 .. 100 -> x * x - 4 ]
|> List.min
|> printfn "%A"

Output

-4

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

See Also

Reference

Collections.List Module (F#)

Microsoft.FSharp.Collections Namespace (F#)