Export (0) Print
Expand All
Expand Minimize

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

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

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

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

// Signature:
Array.maxBy : ('T -> 'U) -> 'T [] -> 'T (requires comparison)

// Usage:
Array.maxBy projection array

projection

Type: 'T -> 'U

The function to transform the elements into a type supporting comparison.

array

Type: 'T []

The input array.

Exception

Condition

ArgumentException

Thrown when the input array 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 example demonstrates the use of Array.maxBy.

[| -10.0 .. 10.0 |]
|> Array.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:
© 2015 Microsoft