Data.Vector.MVector

Generic interface to mutable vectors

Documentation

class MVectorPure v a where

Basic pure functions on mutable vectors

Methods

length :: v a -> Int

Length of the mutable vector

unsafeSlice

Arguments

:: v a

-> Int

starting index

-> Int

length of the slice

-> v a

Yield a part of the mutable vector without copying it. No range checks!

overlaps :: v a -> v a -> Bool

Instances

Unbox a => MVectorPure (Vector s) a

MVectorPure (Vector s) a

class (Monad m, MVectorPure v a) => MVector v m a where

Class of mutable vectors. The type m is the monad in which the mutable vector can be transformed and a is the type of elements.

Methods

unsafeNew :: Int -> m (v a)

Create a mutable vector of the given length. Length is not checked!

unsafeNewWith :: Int -> a -> m (v a)

Create a mutable vector of the given length and fill it with an initial value. Length is not checked!

unsafeRead :: v a -> Int -> m a

Yield the element at the given position. Index is not checked!

unsafeWrite :: v a -> Int -> a -> m ()

Replace the element at the given position. Index is not checked!

clear :: v a -> m ()

Clear all references to external objects

set :: v a -> a -> m ()

Write the value at each position.

unsafeCopy

Arguments

:: v a

target

-> v a

source

-> m ()

Copy a vector. The two vectors may not overlap. This is not checked!

unsafeGrow :: v a -> Int -> m (v a)

Grow a vector by the given number of elements. The length is not checked!

Instances

Unbox a => MVector (Vector s) (ST s) a

MVector (Vector s) (ST s) a

slice :: MVectorPure v a => v a -> Int -> Int -> v a

Yield a part of the mutable vector without copying it. Safer version of unsafeSlice.

new :: MVector v m a => Int -> m (v a)

Create a mutable vector of the given length. Safer version of unsafeNew.

newWith :: MVector v m a => Int -> a -> m (v a)

Create a mutable vector of the given length and fill it with an initial value. Safer version of unsafeNewWith.

read :: MVector v m a => v a -> Int -> m a

Yield the element at the given position. Safer version of unsafeRead.

write :: MVector v m a => v a -> Int -> a -> m ()

Replace the element at the given position. Safer version of unsafeWrite.

copy :: MVector v m a => v a -> v a -> m ()

Copy a vector. The two vectors may not overlap. Safer version of unsafeCopy.

grow :: MVector v m a => v a -> Int -> m (v a)

Grow a vector by the given number of elements. Safer version of unsafeGrow.

unstream :: MVector v m a => Stream a -> m (v a)

Create a new mutable vector and fill it with elements from the Stream. The vector will grow logarithmically if the Size hint of the Stream is inexact.

transform :: MVector v m a => (MStream m a -> MStream m a) -> v a -> m (v a)

update :: MVector v m a => v a -> Stream (Int, a) -> m ()

reverse :: MVector v m a => v a -> m ()