FSharpx.Collections


PhysicistQueue Module

Functions and values

Function or value Description

PhysicistQueue.empty ()

Full Usage: PhysicistQueue.empty ()

Parameters:
    () : unit

Returns: PhysicistQueue<'a>

O(1). Returns queue of no elements.

() : unit
Returns: PhysicistQueue<'a>

PhysicistQueue.fold f state q

Full Usage: PhysicistQueue.fold f state q

Parameters:
Returns: 'State

O(n). 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 : PhysicistQueue<'T>
Returns: 'State

PhysicistQueue.foldBack f q state

Full Usage: PhysicistQueue.foldBack f q state

Parameters:
Returns: 'State

O(n). Applies a function to each element of the queue, threading an accumulator argument through the computation, right to left.

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

PhysicistQueue.head q

Full Usage: PhysicistQueue.head q

Parameters:
Returns: 'T

O(1), amortized. Returns the first element.

q : PhysicistQueue<'T>
Returns: 'T

PhysicistQueue.isEmpty q

Full Usage: PhysicistQueue.isEmpty q

Parameters:
Returns: bool

O(1). Returns true if the queue has no elements.

q : PhysicistQueue<'T>
Returns: bool

PhysicistQueue.length q

Full Usage: PhysicistQueue.length q

Parameters:
Returns: int

O(1). Returns the count of elements.

q : PhysicistQueue<'T>
Returns: int

PhysicistQueue.ofList xs

Full Usage: PhysicistQueue.ofList xs

Parameters:
    xs : 'a list

Returns: PhysicistQueue<'a>

O(1). Returns a queue of the list.

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

PhysicistQueue.ofSeq xs

Full Usage: PhysicistQueue.ofSeq xs

Parameters:
    xs : seq<'a>

Returns: PhysicistQueue<'a>

O(1). Returns a queue of the seq.

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

PhysicistQueue.rev q

Full Usage: PhysicistQueue.rev q

Parameters:
Returns: PhysicistQueue<'T>

O(1). Returns queue reversed.

q : PhysicistQueue<'T>
Returns: PhysicistQueue<'T>

PhysicistQueue.snoc x q

Full Usage: PhysicistQueue.snoc x q

Parameters:
Returns: PhysicistQueue<'T>

O(1), amortized. Returns a new queue with the element added to the end.

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

PhysicistQueue.tail q

Full Usage: PhysicistQueue.tail q

Parameters:
Returns: PhysicistQueue<'T>

O(1), amortized. Returns a new queue of the elements trailing the first element.

q : PhysicistQueue<'T>
Returns: PhysicistQueue<'T>

PhysicistQueue.tryGetHead q

Full Usage: PhysicistQueue.tryGetHead q

Parameters:
Returns: 'T option

O(1), amortized. Returns option first element.

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

PhysicistQueue.tryGetTail q

Full Usage: PhysicistQueue.tryGetTail q

Parameters:
Returns: PhysicistQueue<'T> option

O(1), amortized. Returns option queue of the elements trailing the first element.

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

PhysicistQueue.tryUncons q

Full Usage: PhysicistQueue.tryUncons q

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

O(1), amortized. Returns option first element and tail.

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

PhysicistQueue.uncons q

Full Usage: PhysicistQueue.uncons q

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

O(1), amortized. Returns the first element and tail.

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

Active patterns

Active pattern Description

PhysicistQueue.(|Cons|Nil|) q

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

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