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

  • Article

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

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

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

// Signature:
Seq.maxBy : ('T -> 'U) -> seq<'T> -> 'T (requires comparison)

// Usage:
Seq.maxBy projection source

Parameters

  • projection
    Type: 'T -> 'U

    A function to transform items from the input sequence into comparable keys.

  • source
    Type: seq<'T>

    The input sequence.

Exceptions

Exception

Condition

ArgumentException

Thrown when the input sequence is empty.

ArgumentNullException

Thrown when the input sequence is null.

Return Value

The result sequence.

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.

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.Seq Module (F#)

Microsoft.FSharp.Collections Namespace (F#)