Table of contents
TOC
Collapse the table of content
Expand the table of content

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

Den Delimarsky|Last Updated: 6/8/2016
|
1 Contributor

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)

Syntax

// 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.

Return Value

Returns 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 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

Collections.Array Module (F#)

Microsoft.FSharp.Collections Namespace (F#)

© 2016 Microsoft