Share via

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

  • Article

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

Parameters

  • projection
    Type: 'T -> 'U

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

  • array
    Type: 'T []

    The input array.

Exceptions

Exception

Condition

ArgumentException

Thrown when the input array is empty.

Return Value

The maximum element.

Remarks

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.

Example

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

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

Collections.Array Module (F#)

Microsoft.FSharp.Collections Namespace (F#)