Data.Vector.Growable

Documentation

data Growable v s a

Growable is a dynamic vector based on mutable vector v.

Type synonyms

type GrowableVector = Growable MVector

type GrowableUnboxedVector = Growable MVector

type GrowableStorableVector = Growable MVector

type GrowableIOVector = Growable MVector RealWorld

type GrowableUnboxedIOVector = Growable MVector RealWorld

type GrowableStorableIOVector = Growable MVector RealWorld

Operations

new :: (PrimMonad m, MVector v a) => m (Growable v (PrimState m) a)

Create an empty vector

withCapacity :: (PrimMonad m, MVector v a) => Int -> m (Growable v (PrimState m) a)

Create an empty vector with the given number of pre-allocated elements.

replicate :: (PrimMonad m, MVector v a) => Int -> a -> m (Growable v (PrimState m) a)

Create a vector and fill with the initial value.

replicateM :: (PrimMonad m, MVector v a) => Int -> m a -> m (Growable v (PrimState m) a)

Like replicate, but initialises the elements by running the action repeatedly

push :: (PrimMonad m, MVector v a) => Growable v (PrimState m) a -> a -> m ()

Append an element to the vector (not atomic).

pop :: (PrimMonad m, MVector v a) => Growable v (PrimState m) a -> m (Maybe a)

Pop the last element. Returns Nothing if the vector is empty.

length :: PrimMonad m => Growable v (PrimState m) a -> m Int

Get the length of the vector.

null :: PrimMonad m => Growable v (PrimState m) a -> m Bool

Returns True if the vector is empty

read :: (PrimMonad m, MVector v a, MonadThrow m) => Growable v (PrimState m) a -> Int -> m a

May throw IndexOutOfBounds

write :: (PrimMonad m, MVector v a, MonadThrow m) => Growable v (PrimState m) a -> Int -> a -> m ()

Throws IndexOutOfBounds if the index is larger than the size.

modify :: (PrimMonad m, MVector v a, MonadThrow m) => Growable v (PrimState m) a -> (a -> a) -> Int -> m ()

thaw :: (Vector v a, PrimMonad m) => v a -> m (Growable (Mutable v) (PrimState m) a)

Thaw an immutable vector and create a Growable one.

freeze :: (Vector v a, PrimMonad m) => Growable (Mutable v) (PrimState m) a -> m (v a)

Take a snapshot of a Growable vector.

unsafeFreeze :: (Vector v a, PrimMonad m) => Growable (Mutable v) (PrimState m) a -> m (v a)

Take a snapshot of a Growable vector. The original vector may not be used.

fromGrowable :: (PrimMonad m, MVector v a) => Growable v (PrimState m) a -> m (v (PrimState m) a)

Turn Growable vector into a regular mutable vector.

toGrowable :: (PrimMonad m, MVector v a) => v (PrimState m) a -> m (Growable v (PrimState m) a)

Create a Growable vector from a mutable vector.