Copyright  (c) Roman Leshchinskiy 20082010 

License  BSDstyle 
Maintainer  Roman Leshchinskiy <rl@cse.unsw.edu.au> 
Stability  experimental 
Portability  nonportable 
Safe Haskell  None 
Language  Haskell2010 
Mutable boxed vectors.
Synopsis
 data MVector s a = MVector !Int !Int !(MutableArray s a)
 type IOVector = MVector RealWorld
 type STVector s = MVector s
 length :: MVector s a > Int
 null :: MVector s a > Bool
 slice :: Int > Int > MVector s a > MVector s a
 init :: MVector s a > MVector s a
 tail :: MVector s a > MVector s a
 take :: Int > MVector s a > MVector s a
 drop :: Int > MVector s a > MVector s a
 splitAt :: Int > MVector s a > (MVector s a, MVector s a)
 unsafeSlice :: Int > Int > MVector s a > MVector s a
 unsafeInit :: MVector s a > MVector s a
 unsafeTail :: MVector s a > MVector s a
 unsafeTake :: Int > MVector s a > MVector s a
 unsafeDrop :: Int > MVector s a > MVector s a
 overlaps :: MVector s a > MVector s a > Bool
 new :: PrimMonad m => Int > m (MVector (PrimState m) a)
 unsafeNew :: PrimMonad m => Int > m (MVector (PrimState m) a)
 replicate :: PrimMonad m => Int > a > m (MVector (PrimState m) a)
 replicateM :: PrimMonad m => Int > m a > m (MVector (PrimState m) a)
 clone :: PrimMonad m => MVector (PrimState m) a > m (MVector (PrimState m) a)
 grow :: PrimMonad m => MVector (PrimState m) a > Int > m (MVector (PrimState m) a)
 unsafeGrow :: PrimMonad m => MVector (PrimState m) a > Int > m (MVector (PrimState m) a)
 clear :: PrimMonad m => MVector (PrimState m) a > m ()
 read :: PrimMonad m => MVector (PrimState m) a > Int > m a
 write :: PrimMonad m => MVector (PrimState m) a > Int > a > m ()
 modify :: PrimMonad m => MVector (PrimState m) a > (a > a) > Int > m ()
 swap :: PrimMonad m => MVector (PrimState m) a > Int > Int > m ()
 unsafeRead :: PrimMonad m => MVector (PrimState m) a > Int > m a
 unsafeWrite :: PrimMonad m => MVector (PrimState m) a > Int > a > m ()
 unsafeModify :: PrimMonad m => MVector (PrimState m) a > (a > a) > Int > m ()
 unsafeSwap :: PrimMonad m => MVector (PrimState m) a > Int > Int > m ()
 nextPermutation :: (PrimMonad m, Ord e) => MVector (PrimState m) e > m Bool
 set :: PrimMonad m => MVector (PrimState m) a > a > m ()
 copy :: PrimMonad m => MVector (PrimState m) a > MVector (PrimState m) a > m ()
 move :: PrimMonad m => MVector (PrimState m) a > MVector (PrimState m) a > m ()
 unsafeCopy :: PrimMonad m => MVector (PrimState m) a > MVector (PrimState m) a > m ()
 unsafeMove :: PrimMonad m => MVector (PrimState m) a > MVector (PrimState m) a > m ()
 fromMutableArray :: PrimMonad m => MutableArray (PrimState m) a > m (MVector (PrimState m) a)
 toMutableArray :: PrimMonad m => MVector (PrimState m) a > m (MutableArray (PrimState m) a)
Mutable boxed vectors
Mutable boxed vectors keyed on the monad they live in (IO
or
).ST
s
MVector  

Instances
Accessors
Length information
Extracting subvectors
Yield a part of the mutable vector without copying it. The vector must
contain at least i+n
elements.
Yield a part of the mutable vector without copying it. No bounds checks are performed.
unsafeInit :: MVector s a > MVector s a Source #
unsafeTail :: MVector s a > MVector s a Source #
Overlapping
Construction
Initialisation
new :: PrimMonad m => Int > m (MVector (PrimState m) a) Source #
Create a mutable vector of the given length.
unsafeNew :: PrimMonad m => Int > m (MVector (PrimState m) a) Source #
Create a mutable vector of the given length. The vector elements are set to bottom so accessing them will cause an exception.
Since: 0.5
replicate :: PrimMonad m => Int > a > m (MVector (PrimState m) a) Source #
Create a mutable vector of the given length (0 if the length is negative) and fill it with an initial value.
replicateM :: PrimMonad m => Int > m a > m (MVector (PrimState m) a) Source #
Create a mutable vector of the given length (0 if the length is negative) and fill it with values produced by repeatedly executing the monadic action.
clone :: PrimMonad m => MVector (PrimState m) a > m (MVector (PrimState m) a) Source #
Create a copy of a mutable vector.
Growing
grow :: PrimMonad m => MVector (PrimState m) a > Int > m (MVector (PrimState m) a) Source #
Grow a boxed vector by the given number of elements. The number must be
nonnegative. Same semantics as in grow
for generic vector. It differs
from grow
functions for unpacked vectors, however, in that only pointers to
values are copied over, therefore values themselves will be shared between
two vectors. This is an important distinction to know about during memory
usage analysis and in case when values themselves are of a mutable type, eg.
IORef
or another mutable vector.
Examples
>>>
import qualified Data.Vector as V
>>>
import qualified Data.Vector.Mutable as MV
>>>
mv < V.thaw $ V.fromList ([10, 20, 30] :: [Integer])
>>>
mv' < MV.grow mv 2
The two extra elements at the end of the newly allocated vector will be uninitialized and will result in an error if evaluated, so me must overwrite them with new values first:
>>>
MV.write mv' 3 999
>>>
MV.write mv' 4 777
>>>
V.unsafeFreeze mv'
[10,20,30,999,777]
It is important to note that the source mutable vector is not affected when the newly allocated one is mutated.
>>>
MV.write mv' 2 888
>>>
V.unsafeFreeze mv'
[10,20,888,999,777]>>>
V.unsafeFreeze mv
[10,20,30]
Since: 0.5
unsafeGrow :: PrimMonad m => MVector (PrimState m) a > Int > m (MVector (PrimState m) a) Source #
Grow a vector by the given number of elements. The number must be nonnegative but
this is not checked. Same semantics as in unsafeGrow
for generic vector.
Since: 0.5
Restricting memory usage
clear :: PrimMonad m => MVector (PrimState m) a > m () Source #
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 (PrimState m) a > Int > m a Source #
Yield the element at the given position.
write :: PrimMonad m => MVector (PrimState m) a > Int > a > m () Source #
Replace the element at the given position.
modify :: PrimMonad m => MVector (PrimState m) a > (a > a) > Int > m () Source #
Modify the element at the given position.
swap :: PrimMonad m => MVector (PrimState m) a > Int > Int > m () Source #
Swap the elements at the given positions.
unsafeRead :: PrimMonad m => MVector (PrimState m) a > Int > m a Source #
Yield the element at the given position. No bounds checks are performed.
unsafeWrite :: PrimMonad m => MVector (PrimState m) a > Int > a > m () Source #
Replace the element at the given position. No bounds checks are performed.
unsafeModify :: PrimMonad m => MVector (PrimState m) a > (a > a) > Int > m () Source #
Modify the element at the given position. No bounds checks are performed.
unsafeSwap :: PrimMonad m => MVector (PrimState m) a > Int > Int > m () Source #
Swap the elements at the given positions. No bounds checks are performed.
Modifying vectors
nextPermutation :: (PrimMonad m, Ord e) => MVector (PrimState m) e > m Bool Source #
Compute the next (lexicographically) permutation of given vector inplace. Returns False when input is the last permutation
Filling and copying
set :: PrimMonad m => MVector (PrimState m) a > a > m () Source #
Set all elements of the vector to the given value.
Copy a vector. The two vectors must have the same length and may not overlap.
Move the contents of a vector. The two vectors must have the same length.
If the vectors do not overlap, then this is equivalent to copy
.
Otherwise, the copying is performed as if the source vector were
copied to a temporary vector and then the temporary vector was copied
to the target vector.
Copy a vector. The two vectors must have the same length and may not overlap. This is not checked.
Move the contents of a vector. The two vectors must have the same length, but this is not checked.
If the vectors do not overlap, then this is equivalent to unsafeCopy
.
Otherwise, the copying is performed as if the source vector were
copied to a temporary vector and then the temporary vector was copied
to the target vector.
Arrays
fromMutableArray :: PrimMonad m => MutableArray (PrimState m) a > m (MVector (PrimState m) a) Source #
O(n) Make a copy of a mutable array to a new mutable vector.
Since: 0.12.2.0
toMutableArray :: PrimMonad m => MVector (PrimState m) a > m (MutableArray (PrimState m) a) Source #
O(n) Make a copy of a mutable vector into a new mutable array.
Since: 0.12.2.0