List.minBy<'T,'U> Function (F#)
Returns the lowest of all elements of the list, compared by using Operators.min on the function result.
Namespace/Module Path: Microsoft.FSharp.Collections.List
Assembly: FSharp.Core (in FSharp.Core.dll)
// Signature:
List.minBy : ('T -> 'U) -> 'T list -> 'T (requires comparison)
// Usage:
List.minBy projection list
Parameters
projection
Type: 'T -> 'UThe function to transform list elements into the type to be compared.
list
Type: 'T listThe input list.
Exceptions
Exception |
Condition |
---|---|
Thrown when the list is empty. |
Return Value
The minimum value.
Remarks
This function is named MinBy in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name.
Example
The following code shows how to use List.minBy.
[ -10.0 .. 10.0 ]
|> List.minBy (fun x -> x * x - 1.0)
|> printfn "%A"
Output
0.0
Platforms
Windows 7, Windows Vista SP2, Windows XP SP3, Windows XP x64 SP2, Windows Server 2008 R2, Windows Server 2008 SP2, Windows Server 2003 SP2
Version Information
F# Runtime
Supported in: 2.0, 4.0
Silverlight
Supported in: 3
See Also
Reference
Microsoft.FSharp.Collections Namespace (F#)
Change History
Date |
History |
Reason |
---|---|---|
August 2010 |
Added code example. |
Information enhancement. |