fsprojects/FSharpx.Collections


BatchedQueue

Namespace: FSharpx.Collections.Experimental

Functions and values

Function or valueDescription
empty ()
Signature: unit -> BatchedQueue<'T>
Type parameters: 'T

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

fold f state q
Signature: f:('State -> 'T -> 'State) -> state:'State -> q:BatchedQueue<'T> -> 'State
Type parameters: 'State, 'T

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

foldBack f q state
Signature: f:('T -> 'State -> 'State) -> q:BatchedQueue<'T> -> state:'State -> 'State
Type parameters: 'T, 'State

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

head q
Signature: q:BatchedQueue<'T> -> 'T
Type parameters: 'T

returns the first element

isEmpty q
Signature: q:BatchedQueue<'T> -> bool
Type parameters: 'T

returns true if the queue has no elements

length q
Signature: q:BatchedQueue<'T> -> int
Type parameters: 'T

returns the count of elememts

ofList xs
Signature: xs:'?14207 list -> BatchedQueue<'?14207>
Type parameters: '?14207

returns a queue of the list

ofSeq xs
Signature: xs:seq<'?14209> -> BatchedQueue<'?14209>
Type parameters: '?14209

returns a queue of the seq

rev q
Signature: q:BatchedQueue<'T> -> BatchedQueue<'T>
Type parameters: 'T

returns queue reversed

snoc x q
Signature: x:'T -> q:BatchedQueue<'T> -> BatchedQueue<'T>
Type parameters: 'T

returns a new queue with the element added to the end

tail q
Signature: q:BatchedQueue<'T> -> BatchedQueue<'T>
Type parameters: 'T

returns a new queue of the elements trailing the first element

tryGetHead q
Signature: q:BatchedQueue<'T> -> 'T option
Type parameters: 'T

returns option first element

tryGetTail q
Signature: q:BatchedQueue<'T> -> BatchedQueue<'T> option
Type parameters: 'T

returns option queue of the elements trailing the first element

tryUncons q
Signature: q:BatchedQueue<'T> -> ('T * BatchedQueue<'T>) option
Type parameters: 'T

returns option first element and tail

uncons q
Signature: q:BatchedQueue<'T> -> 'T * BatchedQueue<'T>
Type parameters: 'T

returns the first element and tail

Active patterns

Active patternDescription
( |Cons|Nil| ) q
Signature: q:BatchedQueue<'T> -> Choice<('T * BatchedQueue<'T>),unit>
Type parameters: 'T

CompiledName: |Cons|Nil|

Fork me on GitHub