Data.Vector.Hybrid.Mutable

Documentation

data MVector :: (* -> * -> *) -> (* -> * -> *) -> * -> * -> *

Instances

(MVector u a, MVector v b) => MVector (MVector u v) (a, b)

Defined in Data.Vector.Hybrid.Internal

Methods

basicLength :: MVector u v s (a, b) -> Int

basicUnsafeSlice :: Int -> Int -> MVector u v s (a, b) -> MVector u v s (a, b)

basicOverlaps :: MVector u v s (a, b) -> MVector u v s (a, b) -> Bool

basicUnsafeNew :: Int -> ST s (MVector u v s (a, b))

basicInitialize :: MVector u v s (a, b) -> ST s ()

basicUnsafeReplicate :: Int -> (a, b) -> ST s (MVector u v s (a, b))

basicUnsafeRead :: MVector u v s (a, b) -> Int -> ST s (a, b)

basicUnsafeWrite :: MVector u v s (a, b) -> Int -> (a, b) -> ST s ()

basicClear :: MVector u v s (a, b) -> ST s ()

basicSet :: MVector u v s (a, b) -> (a, b) -> ST s ()

basicUnsafeCopy :: MVector u v s (a, b) -> MVector u v s (a, b) -> ST s ()

basicUnsafeMove :: MVector u v s (a, b) -> MVector u v s (a, b) -> ST s ()

basicUnsafeGrow :: MVector u v s (a, b) -> Int -> ST s (MVector u v s (a, b))

type IOVector u v = MVector u v RealWorld

type STVector = MVector

Accessors

Length information

length :: MVector u a => MVector u v s (a, b) -> Int

Length of the mutable vector.

null :: MVector u a => MVector u v s (a, b) -> Bool

Check whether the vector is empty

Extracting subvectors

slice :: (MVector u a, MVector v b) => Int -> Int -> MVector u v s (a, b) -> MVector u v s (a, b)

Yield a part of the mutable vector without copying it.

init :: (MVector u a, MVector v b) => MVector u v s (a, b) -> MVector u v s (a, b)

tail :: (MVector u a, MVector v b) => MVector u v s (a, b) -> MVector u v s (a, b)

take :: (MVector u a, MVector v b) => Int -> MVector u v s (a, b) -> MVector u v s (a, b)

drop :: (MVector u a, MVector v b) => Int -> MVector u v s (a, b) -> MVector u v s (a, b)

unsafeSlice

Arguments

:: (MVector u a, MVector v b)

=> Int

starting index

-> Int

length of the slice

-> MVector u v s (a, b)

-> MVector u v s (a, b)

Yield a part of the mutable vector without copying it. No bounds checks are performed.

unsafeInit :: (MVector u a, MVector v b) => MVector u v s (a, b) -> MVector u v s (a, b)

unsafeTail :: (MVector u a, MVector v b) => MVector u v s (a, b) -> MVector u v s (a, b)

unsafeTake :: (MVector u a, MVector v b) => Int -> MVector u v s (a, b) -> MVector u v s (a, b)

unsafeDrop :: (MVector u a, MVector v b) => Int -> MVector u v s (a, b) -> MVector u v s (a, b)

Overlapping

overlaps :: (MVector u a, MVector v b) => MVector u v s (a, b) -> MVector u v s (a, b) -> Bool

Construction

Initialisation

new :: (PrimMonad m, MVector u a, MVector v b) => Int -> m (MVector u v (PrimState m) (a, b))

Create a mutable vector of the given length.

unsafeNew :: (PrimMonad m, MVector u a, MVector v b) => Int -> m (MVector u v (PrimState m) (a, b))

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

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

Create a mutable vector of the given length (0 if the length is negative) and fill it with an initial value.

clone :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> m (MVector u v (PrimState m) (a, b))

Create a copy of a mutable vector.

Growing

grow :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> m (MVector u v (PrimState m) (a, b))

Grow a vector by the given number of elements. The number must be positive.

unsafeGrow :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> m (MVector u v (PrimState m) (a, b))

Grow a vector by the given number of elements. The number must be positive but this is not checked.

Restricting memory usage

clear :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> m ()

Reset all elements of the vector to some undefined value, clearing all references to external objects. This is usually a noop for unboxed vectors.

Accessing individual elements

read :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> m (a, b)

Yield the element at the given position.

write :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> (a, b) -> m ()

Replace the element at the given position.

swap :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> Int -> m ()

Swap the elements at the given positions.

unsafeRead :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> m (a, b)

Yield the element at the given position. No bounds checks are performed.

unsafeWrite :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> (a, b) -> m ()

Replace the element at the given position. No bounds checks are performed.

unsafeSwap :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> Int -> Int -> m ()

Swap the elements at the given positions. No bounds checks are performed.

Modifying vectors

Filling and copying

set :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> (a, b) -> m ()

Set all elements of the vector to the given value.

copy :: (PrimMonad m, MVector u a, MVector v b) => MVector u v (PrimState m) (a, b) -> MVector u v (PrimState m) (a, b) -> m ()

Copy a vector. The two vectors must have the same length and may not overlap.

unsafeCopy

Arguments

:: (PrimMonad m, MVector u a, MVector v b)

=> MVector u v (PrimState m) (a, b)

target

-> MVector u v (PrimState m) (a, b)

source

-> m ()

Copy a vector. The two vectors must have the same length and may not overlap. This is not checked.

Unsafe Construction and deconstruction

unsafeZip :: u s a -> v s b -> MVector u v s (a, b)

The mutable vectors are assumed to be of the same length and to not overlap. This is not checked.

projectFst :: MVector u v s (a, b) -> u s a

projectSnd :: MVector u v s (a, b) -> v s b

Deprecated operations

newWith :: (PrimMonad m, MVector u a, MVector v b) => Int -> (a, b) -> m (MVector u v (PrimState m) (a, b))

Deprecated: Use replicate instead

DEPRECATED Use replicate instead

unsafeNewWith :: (PrimMonad m, MVector u a, MVector v b) => Int -> (a, b) -> m (MVector u v (PrimState m) (a, b))

Deprecated: Use replicate instead

DEPRECATED Use replicate instead