Data.RRBVector.Internal.Buffer

This is an internal module.

A Buffer is an array with a fixed capacity, used to build up Arrays. It is used in the implementation of fromList and ><.

Documentation

data Buffer s a

A mutable array buffer with a fixed capacity.

new :: Int -> ST s (Buffer s a)

\(O(n)\). Create a new empty buffer with the given capacity.

push :: Buffer s a -> a -> ST s ()

\(O(1)\). Push a new element onto the buffer. The size of the buffer must not exceed the capacity, but this is not checked.

get :: Buffer s a -> ST s (Array a)

\(O(n)\). Freeze the content of the buffer and return it. This resets the buffer so that it is empty.

size :: Buffer s a -> ST s Int

\(O(1)\). Return the current size of the buffer.