FSharpx.Collections


RealTimeDeque Module

Functions and values

Function or value Description

RealTimeDeque.append xs ys

Full Usage: RealTimeDeque.append xs ys

Parameters:
Returns: RealTimeDeque<'T>

O(|ys-xs|). Returns a deque of the two deques concatenated, front-back stream ratio constant defaulted to 2.

xs : RealTimeDeque<'T>
ys : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

RealTimeDeque.appendC c xs ys

Full Usage: RealTimeDeque.appendC c xs ys

Parameters:
Returns: RealTimeDeque<'T>

O(|ys-xs|). Returns a deque of the two deques concatenated, c is front-back stream ratio constant, should be at least 2.

c : int
xs : RealTimeDeque<'T>
ys : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

RealTimeDeque.cons x q

Full Usage: RealTimeDeque.cons x q

Parameters:
Returns: RealTimeDeque<'T>

O(1), worst case. Returns a new deque with the element added to the beginning.

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

RealTimeDeque.empty c

Full Usage: RealTimeDeque.empty c

Parameters:
    c : int

Returns: RealTimeDeque<'a>

O(1). Returns deque of no elements, c is front-back stream ration constant, should be at least 2.

c : int
Returns: RealTimeDeque<'a>

RealTimeDeque.head q

Full Usage: RealTimeDeque.head q

Parameters:
Returns: 'T

O(1), worst case. Returns the first element.

q : RealTimeDeque<'T>
Returns: 'T

RealTimeDeque.init q

Full Usage: RealTimeDeque.init q

Parameters:
Returns: RealTimeDeque<'T>

O(1), worst case. Returns a new deque of the elements before the last element.

q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

RealTimeDeque.isEmpty q

Full Usage: RealTimeDeque.isEmpty q

Parameters:
Returns: bool

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

q : RealTimeDeque<'T>
Returns: bool

RealTimeDeque.last q

Full Usage: RealTimeDeque.last q

Parameters:
Returns: 'T

O(1), worst case. Returns the last element.

q : RealTimeDeque<'T>
Returns: 'T

RealTimeDeque.length q

Full Usage: RealTimeDeque.length q

Parameters:
Returns: int

O(1). Returns the count of elements.

q : RealTimeDeque<'T>
Returns: int

RealTimeDeque.lookup i q

Full Usage: RealTimeDeque.lookup i q

Parameters:
Returns: 'T

O(n/2), worst case. Returns option element by index.

i : int
q : RealTimeDeque<'T>
Returns: 'T

RealTimeDeque.ofCatLists xs ys

Full Usage: RealTimeDeque.ofCatLists xs ys

Parameters:
    xs : 'a list
    ys : 'a list

Returns: RealTimeDeque<'a>

O(|ys-xs|). Returns a deque of the two lists concatenated, front-back stream ratio constant defaulted to 2.

xs : 'a list
ys : 'a list
Returns: RealTimeDeque<'a>

RealTimeDeque.ofCatListsC c xs ys

Full Usage: RealTimeDeque.ofCatListsC c xs ys

Parameters:
    c : int
    xs : 'a list
    ys : 'a list

Returns: RealTimeDeque<'a>

O(|ys-xs|). Returns a deque of the two lists concatenated, c is front-back stream ration constant, should be at least 2.

c : int
xs : 'a list
ys : 'a list
Returns: RealTimeDeque<'a>

RealTimeDeque.ofCatSeqs xs ys

Full Usage: RealTimeDeque.ofCatSeqs xs ys

Parameters:
    xs : seq<'a>
    ys : seq<'a>

Returns: RealTimeDeque<'a>

O(|ys-xs|). Returns a deque of the two seqs concatenated, front-back stream ratio constant defaulted to 2.

xs : seq<'a>
ys : seq<'a>
Returns: RealTimeDeque<'a>

RealTimeDeque.ofCatSeqsC c xs ys

Full Usage: RealTimeDeque.ofCatSeqsC c xs ys

Parameters:
    c : int
    xs : seq<'a>
    ys : seq<'a>

Returns: RealTimeDeque<'a>

O(|ys-xs|). Returns a deque of the two seqs concatenated, c is front-back stream ratio constant, should be at least 2.

c : int
xs : seq<'a>
ys : seq<'a>
Returns: RealTimeDeque<'a>

RealTimeDeque.ofSeq xs

Full Usage: RealTimeDeque.ofSeq xs

Parameters:
    xs : seq<'a>

Returns: RealTimeDeque<'a>

O(n). Returns a deque of the seq, front-back stream ratio constant defaulted to 2.

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

RealTimeDeque.ofSeqC c xs

Full Usage: RealTimeDeque.ofSeqC c xs

Parameters:
    c : int
    xs : seq<'a>

Returns: RealTimeDeque<'a>

O(n). Returns a deque of the seq, c is front-back stream ratio constant, should be at least 2.

c : int
xs : seq<'a>
Returns: RealTimeDeque<'a>

RealTimeDeque.remove i q

Full Usage: RealTimeDeque.remove i q

Parameters:
Returns: RealTimeDeque<'T>

O(n/2), worst case. Returns deque with element removed by index.

i : int
q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

RealTimeDeque.rev q

Full Usage: RealTimeDeque.rev q

Parameters:
Returns: RealTimeDeque<'T>

O(1). Returns deque reversed.

q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

RealTimeDeque.singleton x

Full Usage: RealTimeDeque.singleton x

Parameters:
    x : 'a

Returns: RealTimeDeque<'a>

O(1). Returns a deque of one element, front-back stream ratio constant defaulted to 2.

x : 'a
Returns: RealTimeDeque<'a>

RealTimeDeque.singletonC c x

Full Usage: RealTimeDeque.singletonC c x

Parameters:
    c : int
    x : 'a

Returns: RealTimeDeque<'a>

O(1). Returns a deque of one element, c is front-back stream ratio constant, should be at least 2.

c : int
x : 'a
Returns: RealTimeDeque<'a>

RealTimeDeque.snoc x q

Full Usage: RealTimeDeque.snoc x q

Parameters:
Returns: RealTimeDeque<'T>

O(1), worst case. Returns a new deque with the element added to the end.

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

RealTimeDeque.tail q

Full Usage: RealTimeDeque.tail q

Parameters:
Returns: RealTimeDeque<'T>

O(1), worst case. Returns a new deque of the elements trailing the first element.

q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

RealTimeDeque.tryGetHead q

Full Usage: RealTimeDeque.tryGetHead q

Parameters:
Returns: 'T option

O(1), worst case. Returns option first element.

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

RealTimeDeque.tryGetInit q

Full Usage: RealTimeDeque.tryGetInit q

Parameters:
Returns: RealTimeDeque<'T> option

O(1), worst case. Returns option deque of the elements before the last element.

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

RealTimeDeque.tryGetLast q

Full Usage: RealTimeDeque.tryGetLast q

Parameters:
Returns: 'T option

O(1), worst case. Returns option last element.

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

RealTimeDeque.tryGetTail q

Full Usage: RealTimeDeque.tryGetTail q

Parameters:
Returns: RealTimeDeque<'T> option

O(1), worst case. Returns option deque of the elements trailing the first element.

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

RealTimeDeque.tryLookup i q

Full Usage: RealTimeDeque.tryLookup i q

Parameters:
Returns: 'T option

O(n/2), worst case. Returns option element by index.

i : int
q : RealTimeDeque<'T>
Returns: 'T option

RealTimeDeque.tryRemove i q

Full Usage: RealTimeDeque.tryRemove i q

Parameters:
Returns: RealTimeDeque<'T> option

O(n/2), worst case. Returns option deque with element removed by index.

i : int
q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T> option

RealTimeDeque.tryUncons q

Full Usage: RealTimeDeque.tryUncons q

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

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

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

RealTimeDeque.tryUnsnoc q

Full Usage: RealTimeDeque.tryUnsnoc q

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

O(1), worst case. Returns option init and the last element.

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

RealTimeDeque.tryUpdate i y q

Full Usage: RealTimeDeque.tryUpdate i y q

Parameters:
Returns: RealTimeDeque<'T> option

O(n/2), worst case. Returns option deque with element updated by index.

i : int
y : 'T
q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T> option

RealTimeDeque.uncons q

Full Usage: RealTimeDeque.uncons q

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

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

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

RealTimeDeque.unsnoc q

Full Usage: RealTimeDeque.unsnoc q

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

O(1), worst case. Returns init and the last element.

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

RealTimeDeque.update i y q

Full Usage: RealTimeDeque.update i y q

Parameters:
Returns: RealTimeDeque<'T>

O(n/2), worst case. Returns deque with element updated by index.

i : int
y : 'T
q : RealTimeDeque<'T>
Returns: RealTimeDeque<'T>

Active patterns

Active pattern Description

RealTimeDeque.(|Cons|Nil|) q

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

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

RealTimeDeque.(|Snoc|Nil|) q

Full Usage: RealTimeDeque.(|Snoc|Nil|) q

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