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

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

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

Applies the given function to successive elements, returning the first result where function returns Some. If the function never returns Some then System.Collections.Generic.KeyNotFoundException is raised.

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

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

Syntax

// Signature:
Array.pick : ('T -> 'U option) -> 'T [] -> 'U

// Usage:
Array.pick chooser array

Parameters

chooser Type: 'T -> 'U option

The function to generate options from the elements.

array Type: 'T []

The input array.

Return Value

Returns the first result.

Remarks

This function is named Pick 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 shows how to use Array.pick.


    let values = [| ("a", 1); ("b", 2); ("c", 3) |]

    let resultPick = Array.pick (fun elem ->
                        match elem with
                        | (value, 2) -> Some value
                        | _ -> None) values
    printfn "%A" resultPick

Output

"b"

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#)

© 2017 Microsoft