FSharpx.Collections


BatchedQueue Module

Functions and values

Function or value Description

BatchedQueue.empty ()

Full Usage: BatchedQueue.empty ()

Parameters:
    () : unit

Returns: BatchedQueue<'T>

returns queue of no elements c is front-back stream ration constant, should be at least 2

() : unit
Returns: BatchedQueue<'T>

BatchedQueue.fold f state q

Full Usage: BatchedQueue.fold f state q

Parameters:
    f : 'State -> 'T -> 'State
    state : 'State
    q : BatchedQueue<'T>

Returns: 'State

applies a function to each element of the queue, threading an accumulator argument through the computation, left to right

f : 'State -> 'T -> 'State
state : 'State
q : BatchedQueue<'T>
Returns: 'State

BatchedQueue.foldBack f q state

Full Usage: BatchedQueue.foldBack f q state

Parameters:
    f : 'T -> 'State -> 'State
    q : BatchedQueue<'T>
    state : 'State

Returns: 'State

applies a function to each element of the queue, threading an accumulator argument through the computation, right to left

f : 'T -> 'State -> 'State
q : BatchedQueue<'T>
state : 'State
Returns: 'State

BatchedQueue.head q

Full Usage: BatchedQueue.head q

Parameters:
Returns: 'T

returns the first element

q : BatchedQueue<'T>
Returns: 'T

BatchedQueue.isEmpty q

Full Usage: BatchedQueue.isEmpty q

Parameters:
Returns: bool

returns true if the queue has no elements

q : BatchedQueue<'T>
Returns: bool

BatchedQueue.length q

Full Usage: BatchedQueue.length q

Parameters:
Returns: int

returns the count of elements

q : BatchedQueue<'T>
Returns: int

BatchedQueue.ofList xs

Full Usage: BatchedQueue.ofList xs

Parameters:
    xs : 'a list

Returns: BatchedQueue<'a>

returns a queue of the list

xs : 'a list
Returns: BatchedQueue<'a>

BatchedQueue.ofSeq xs

Full Usage: BatchedQueue.ofSeq xs

Parameters:
    xs : seq<'a>

Returns: BatchedQueue<'a>

returns a queue of the seq

xs : seq<'a>
Returns: BatchedQueue<'a>

BatchedQueue.rev q

Full Usage: BatchedQueue.rev q

Parameters:
Returns: BatchedQueue<'T>

returns queue reversed

q : BatchedQueue<'T>
Returns: BatchedQueue<'T>

BatchedQueue.snoc x q

Full Usage: BatchedQueue.snoc x q

Parameters:
Returns: BatchedQueue<'T>

returns a new queue with the element added to the end

x : 'T
q : BatchedQueue<'T>
Returns: BatchedQueue<'T>

BatchedQueue.tail q

Full Usage: BatchedQueue.tail q

Parameters:
Returns: BatchedQueue<'T>

returns a new queue of the elements trailing the first element

q : BatchedQueue<'T>
Returns: BatchedQueue<'T>

BatchedQueue.tryGetHead q

Full Usage: BatchedQueue.tryGetHead q

Parameters:
Returns: 'T option

returns option first element

q : BatchedQueue<'T>
Returns: 'T option

BatchedQueue.tryGetTail q

Full Usage: BatchedQueue.tryGetTail q

Parameters:
Returns: BatchedQueue<'T> option

returns option queue of the elements trailing the first element

q : BatchedQueue<'T>
Returns: BatchedQueue<'T> option

BatchedQueue.tryUncons q

Full Usage: BatchedQueue.tryUncons q

Parameters:
Returns: ('T * BatchedQueue<'T>) option

returns option first element and tail

q : BatchedQueue<'T>
Returns: ('T * BatchedQueue<'T>) option

BatchedQueue.uncons q

Full Usage: BatchedQueue.uncons q

Parameters:
Returns: 'T * BatchedQueue<'T>

returns the first element and tail

q : BatchedQueue<'T>
Returns: 'T * BatchedQueue<'T>

Active patterns

Active pattern Description

BatchedQueue.(|Cons|Nil|) q

Full Usage: BatchedQueue.(|Cons|Nil|) q

Parameters:
Returns: Choice<('T * BatchedQueue<'T>), unit>
q : BatchedQueue<'T>
Returns: Choice<('T * BatchedQueue<'T>), unit>