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

Seq.scan<'T,'State> Function (F#)

Den Delimarsky|Last Updated: 7/25/2016
|
1 Contributor

Like Seq.fold, but computes on-demand and returns the sequence of intermediate and final results.

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

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

Syntax

// Signature:
Seq.scan : ('State -> 'T -> 'State) -> 'State -> seq<'T> -> seq<'State>

// Usage:
Seq.scan folder state source

Parameters

folder Type: 'State -> 'T -> 'State

A function that updates the state with each element from the sequence.

state Type: 'State

The initial state.

source Type: seq<'T>

The input sequence.

Exceptions

ExceptionCondition
ArgumentNullExceptionThrown when the input sequence is null.

Return Value

The result sequence.

Remarks

This function is named Scan 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

Collections.Seq Module (F#)

Microsoft.FSharp.Collections Namespace (F#)

© 2016 Microsoft