Share via

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

  • Article

Returns the lowest of all elements of the array, compared by using Operators.min on the function result.

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

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

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

// Usage:
Array.minBy 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 minimum element.

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 example demonstrates the use of Array.minBy.

[| -10.0 .. 10.0 |]
|> Array.minBy (fun x -> x * x - 1.0)
|> 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

Reference

Collections.Array Module (F#)

Microsoft.FSharp.Collections Namespace (F#)