fsprojects/FSharpx.Collections


RingBuffer<'T>

Namespace: FSharpx.Collections.Experimental

Constructors

ConstructorDescription
new(values)
Signature: values:seq<'T> -> RingBuffer<'T>

CompiledName: .ctor

new(size)
Signature: size:int -> RingBuffer<'T>

CompiledName: .ctor

new(position, values)
Signature: (position:int * values:seq<'T>) -> RingBuffer<'T>

CompiledName: .ctor

Instance members

Instance memberDescription
Advance(offset)
Signature: offset:int -> int

Advances the position of the RingBuffer by the offset. Returns the position of the RingBuffer. Throws an ArgumentException if the offset is negative.

Buffer
Signature: 'T []

CompiledName: get_Buffer

Clone()
Signature: unit -> RingBuffer<'T>
Insert(offset, items)
Signature: (offset:int * items:seq<'T>) -> unit
Insert(op, offset, items)
Signature: (op:('T -> 'b -> 'T) * offset:int * items:seq<'b>) -> unit
Normalize()
Signature: unit -> unit
Position()
Signature: unit -> int

CompiledName: set_Position

Position()
Signature: unit -> unit

CompiledName: get_Position

ToArray()
Signature: unit -> 'T []
TryAdvance(offset)
Signature: offset:int -> int option

Tries to advance the position of the RingBuffer by the offset. Returns None if offset is negative, otherwise Some containing the position of the RingBuffer.

Fork me on GitHub