Seq.find<'T> Function (F#)

Article
02/04/2013

Returns the first element for which the given function returns true.

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

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

// Signature:
Seq.find : ('T -> bool) -> seq<'T> -> 'T

// Usage:
Seq.find predicate source

Parameters

predicate
Type: 'T -> bool

A function to test whether an item in the sequence should be returned.
source
Type: seq<'T>

The input sequence.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when the input sequence is null
KeyNotFoundException	Thrown if no element returns true when evaluated by the predicate

Return Value

Returns the first element for which the given function returns true.

Remarks

This function is named Find 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 Seq.find.

let isDivisibleBy number elem = elem % number = 0
let result = Seq.find (isDivisibleBy 5) [ 1 .. 100 ]
printfn "%d " result

Output

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

Share via