Export (0) Print
Expand All
Expand Minimize

List.maxBy<'T,'U> Function (F#)

Returns the greatest of all elements of the list, compared by using Operators.max on the function result.

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

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

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

// Usage:
List.maxBy projection list

projection

Type: 'T -> 'U

The function to transform the list elements into the type to be compared.

list

Type: 'T list

The input list.

Exception

Condition

ArgumentException

Thrown when the list is empty.

The maximum element.

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

The following code shows how to use List.maxBy.

[ -10.0 .. 10.0 ]
|> List.maxBy (fun x -> 1.0 - x * x)
|> printfn "%A"

Output

0.0

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

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

Show:
© 2014 Microsoft