FSharpx.Extras


Enumerator Module

Types

Type Description

EnumerableBuilder

Functions and values

Function or value Description

bind f a

Full Usage: bind f a

Parameters:
Returns: IEnumerator<'U>
f : 'T option -> IEnumerator<'U>
a : IEnumerator<'T>
Returns: IEnumerator<'U>

combine a b

Full Usage: combine a b

Parameters:
Returns: IEnumerator<'a>
a : IEnumerator<'a>
b : IEnumerator<'a>
Returns: IEnumerator<'a>

delay f

Full Usage: delay f

Parameters:
Returns: IEnumerator<'a>
f : unit -> IEnumerator<'a>
Returns: IEnumerator<'a>

empty

Full Usage: empty

Returns: IEnumerator<'T>
Returns: IEnumerator<'T>

firstOrDefault def en

Full Usage: firstOrDefault def en

Parameters:
Returns: 'T
def : 'T
en : IEnumerator<'T>
Returns: 'T

head en

Full Usage: head en

Parameters:
Returns: 'T
en : IEnumerator<'T>
Returns: 'T

iter

Full Usage: iter

Returns: EnumerableBuilder
Returns: EnumerableBuilder

last en

Full Usage: last en

Parameters:
Returns: 'T
en : IEnumerator<'T>
Returns: 'T

lastOrDefault def en

Full Usage: lastOrDefault def en

Parameters:
Returns: 'T
def : 'T
en : IEnumerator<'T>
Returns: 'T

length en

Full Usage: length en

Parameters:
Returns: int
en : IEnumerator<'T>
Returns: int

map f en

Full Usage: map f en

Parameters:
Returns: IEnumerator<'b>
f : 'a -> 'b
en : IEnumerator<'a>
Returns: IEnumerator<'b>

scan f state en

Full Usage: scan f state en

Parameters:
Returns: IEnumerator<'a>

Scan progressively folds over the enumerator, returning a new enumerator that lazily computes each state.

f : 'a -> 'b -> 'a
state : 'a
en : IEnumerator<'b>
Returns: IEnumerator<'a>

scanUntil f state pred en

Full Usage: scanUntil f state pred en

Parameters:
    f : 'a -> 'b -> 'a
    state : 'a
    pred : 'a -> bool
    en : IEnumerator<'b>

Returns: IEnumerator<'a>

Scan progressively folds over the enumerator, returning a new enumerator that lazily computes each state until the provided predicate is true.

f : 'a -> 'b -> 'a
state : 'a
pred : 'a -> bool
en : IEnumerator<'b>
Returns: IEnumerator<'a>

scanWhile f state pred en

Full Usage: scanWhile f state pred en

Parameters:
    f : 'a -> 'b -> 'a
    state : 'a
    pred : 'a -> bool
    en : IEnumerator<'b>

Returns: IEnumerator<'a>

Scan progressively folds over the enumerator, returning a new enumerator that lazily computes each state while the provided predicate is true.

f : 'a -> 'b -> 'a
state : 'a
pred : 'a -> bool
en : IEnumerator<'b>
Returns: IEnumerator<'a>

singleton a

Full Usage: singleton a

Parameters:
    a : 'a

Returns: IEnumerator<'a>
a : 'a
Returns: IEnumerator<'a>

skip n en

Full Usage: skip n en

Parameters:
Returns: IEnumerator<'T>
n : int
en : IEnumerator<'T>
Returns: IEnumerator<'T>

take n en

Full Usage: take n en

Parameters:
Returns: IEnumerator<'T>
n : int
en : IEnumerator<'T>
Returns: IEnumerator<'T>

toSeq gen

Full Usage: toSeq gen

Parameters:
Returns: IEnumerable<'T>
gen : unit -> IEnumerator<'T>
Returns: IEnumerable<'T>

zip xs ys

Full Usage: zip xs ys

Parameters:
Returns: IEnumerator<'a * 'b>
xs : IEnumerator<'a>
ys : IEnumerator<'b>
Returns: IEnumerator<'a * 'b>