FSharpx.Collections


HoodMelvilleQueue Module

Functions and values

Function or value Description

HoodMelvilleQueue.empty ()

Full Usage: HoodMelvilleQueue.empty ()

Parameters:
    () : unit

Returns: HoodMelvilleQueue<'a>

returns queue of no elements

() : unit
Returns: HoodMelvilleQueue<'a>

HoodMelvilleQueue.fold f state q

Full Usage: HoodMelvilleQueue.fold f state q

Parameters:
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 : HoodMelvilleQueue<'T>
Returns: 'State

HoodMelvilleQueue.foldBack f q state

Full Usage: HoodMelvilleQueue.foldBack f q state

Parameters:
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 : HoodMelvilleQueue<'T>
state : 'State
Returns: 'State

HoodMelvilleQueue.head q

Full Usage: HoodMelvilleQueue.head q

Parameters:
Returns: 'T

returns the first element

q : HoodMelvilleQueue<'T>
Returns: 'T

HoodMelvilleQueue.isEmpty q

Full Usage: HoodMelvilleQueue.isEmpty q

Parameters:
Returns: bool

returns true if the queue has no elements

q : HoodMelvilleQueue<'T>
Returns: bool

HoodMelvilleQueue.length q

Full Usage: HoodMelvilleQueue.length q

Parameters:
Returns: int

returns the count of elements

q : HoodMelvilleQueue<'T>
Returns: int

HoodMelvilleQueue.ofList xs

Full Usage: HoodMelvilleQueue.ofList xs

Parameters:
    xs : seq<'a>

Returns: HoodMelvilleQueue<'a>

returns a queue of the list

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

HoodMelvilleQueue.ofSeq xs

Full Usage: HoodMelvilleQueue.ofSeq xs

Parameters:
    xs : seq<'a>

Returns: HoodMelvilleQueue<'a>

returns a queue of the seq

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

HoodMelvilleQueue.snoc x q

Full Usage: HoodMelvilleQueue.snoc x q

Parameters:
Returns: HoodMelvilleQueue<'T>

returns a new queue with the element added to the end

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

HoodMelvilleQueue.tail q

Full Usage: HoodMelvilleQueue.tail q

Parameters:
Returns: HoodMelvilleQueue<'T>

returns a new queue of the elements trailing the first element

q : HoodMelvilleQueue<'T>
Returns: HoodMelvilleQueue<'T>

HoodMelvilleQueue.tryGetHead q

Full Usage: HoodMelvilleQueue.tryGetHead q

Parameters:
Returns: 'T option

returns option first element

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

HoodMelvilleQueue.tryGetTail q

Full Usage: HoodMelvilleQueue.tryGetTail q

Parameters:
Returns: HoodMelvilleQueue<'T> option

returns option queue of the elements trailing the first element

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

HoodMelvilleQueue.tryUncons q

Full Usage: HoodMelvilleQueue.tryUncons q

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

returns option first element and tail

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

HoodMelvilleQueue.uncons q

Full Usage: HoodMelvilleQueue.uncons q

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

returns the first element and tail

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

Active patterns

Active pattern Description

HoodMelvilleQueue.(|Cons|Nil|) q

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

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