Portability | non-portable |
---|---|
Stability | experimental |
Maintainer | Roman Leshchinskiy <rl@cse.unsw.edu.au> |
Safe Haskell | Trustworthy |
Safe interface to Data.Vector.Generic.Mutable
- class MVector v a
- length :: MVector v a => v s a -> Int
- null :: MVector v a => v s a -> Bool
- slice :: MVector v a => Int -> Int -> v s a -> v s a
- init :: MVector v a => v s a -> v s a
- tail :: MVector v a => v s a -> v s a
- take :: MVector v a => Int -> v s a -> v s a
- drop :: MVector v a => Int -> v s a -> v s a
- splitAt :: MVector v a => Int -> v s a -> (v s a, v s a)
- overlaps :: MVector v a => v s a -> v s a -> Bool
- new :: (PrimMonad m, MVector v a) => Int -> m (v (PrimState m) a)
- replicate :: (PrimMonad m, MVector v a) => Int -> a -> m (v (PrimState m) a)
- replicateM :: (PrimMonad m, MVector v a) => Int -> m a -> m (v (PrimState m) a)
- clone :: (PrimMonad m, MVector v a) => v (PrimState m) a -> m (v (PrimState m) a)
- grow :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a)
- clear :: (PrimMonad m, MVector v a) => v (PrimState m) a -> m ()
- read :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m a
- write :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m ()
- swap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m ()
- set :: (PrimMonad m, MVector v a) => v (PrimState m) a -> a -> m ()
- copy :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()
- move :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()
- unstream :: (PrimMonad m, MVector v a) => Stream a -> m (v (PrimState m) a)
- unstreamR :: (PrimMonad m, MVector v a) => Stream a -> m (v (PrimState m) a)
- munstream :: (PrimMonad m, MVector v a) => MStream m a -> m (v (PrimState m) a)
- munstreamR :: (PrimMonad m, MVector v a) => MStream m a -> m (v (PrimState m) a)
- transform :: (PrimMonad m, MVector v a) => (MStream m a -> MStream m a) -> v (PrimState m) a -> m (v (PrimState m) a)
- transformR :: (PrimMonad m, MVector v a) => (MStream m a -> MStream m a) -> v (PrimState m) a -> m (v (PrimState m) a)
- fill :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a -> m (v (PrimState m) a)
- fillR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a -> m (v (PrimState m) a)
- accum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Stream (Int, b) -> m ()
- update :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream (Int, a) -> m ()
- reverse :: (PrimMonad m, MVector v a) => v (PrimState m) a -> m ()
- unstablePartition :: forall m v a. (PrimMonad m, MVector v a) => (a -> Bool) -> v (PrimState m) a -> m Int
- unstablePartitionStream :: (PrimMonad m, MVector v a) => (a -> Bool) -> Stream a -> m (v (PrimState m) a, v (PrimState m) a)
- partitionStream :: (PrimMonad m, MVector v a) => (a -> Bool) -> Stream a -> m (v (PrimState m) a, v (PrimState m) a)
Class of mutable vector types
Class of mutable vectors parametrised with a primitive state token.
Prim a => MVector MVector a | |
Storable a => MVector MVector a | |
MVector MVector Bool | |
MVector MVector Char | |
MVector MVector Double | |
MVector MVector Float | |
MVector MVector Int | |
MVector MVector Int8 | |
MVector MVector Int16 | |
MVector MVector Int32 | |
MVector MVector Int64 | |
MVector MVector Word | |
MVector MVector Word8 | |
MVector MVector Word16 | |
MVector MVector Word32 | |
MVector MVector Word64 | |
MVector MVector () | |
MVector MVector a | |
(RealFloat a, Unbox a) => MVector MVector (Complex a) | |
(Unbox a, Unbox b) => MVector MVector (a, b) | |
(Unbox a, Unbox b, Unbox c) => MVector MVector (a, b, c) | |
(Unbox a, Unbox b, Unbox c, Unbox d) => MVector MVector (a, b, c, d) | |
(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => MVector MVector (a, b, c, d, e) | |
(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => MVector MVector (a, b, c, d, e, f) |
Accessors
Length information
Extracting subvectors
slice :: MVector v a => Int -> Int -> v s a -> v s aSource
Yield a part of the mutable vector without copying it.
Overlapping
Construction
Initialisation
new :: (PrimMonad m, MVector v a) => Int -> m (v (PrimState m) a)Source
Create a mutable vector of the given length.
replicate :: (PrimMonad m, MVector v a) => Int -> a -> m (v (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, MVector v a) => Int -> m a -> m (v (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 v a) => v (PrimState m) a -> m (v (PrimState m) a)Source
Create a copy of a mutable vector.
Growing
grow :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a)Source
Grow a vector by the given number of elements. The number must be positive.
Restricting memory usage
clear :: (PrimMonad m, MVector v a) => v (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 v a) => v (PrimState m) a -> Int -> m aSource
Yield the element at the given position.
write :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m ()Source
Replace the element at the given position.
swap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m ()Source
Swap the elements at the given positions.
Modifying vectors
Filling and copying
set :: (PrimMonad m, MVector v a) => v (PrimState m) a -> a -> m ()Source
Set all elements of the vector to the given value.
copy :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()Source
Copy a vector. The two vectors must have the same length and may not overlap.
move :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()Source
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.
Internal operations
munstream :: (PrimMonad m, MVector v a) => MStream m a -> m (v (PrimState m) a)Source
Create a new mutable vector and fill it with elements from the monadic stream. The vector will grow exponentially if the maximum size of the stream is unknown.
munstreamR :: (PrimMonad m, MVector v a) => MStream m a -> m (v (PrimState m) a)Source
Create a new mutable vector and fill it with elements from the monadic stream from right to left. The vector will grow exponentially if the maximum size of the stream is unknown.
transform :: (PrimMonad m, MVector v a) => (MStream m a -> MStream m a) -> v (PrimState m) a -> m (v (PrimState m) a)Source
transformR :: (PrimMonad m, MVector v a) => (MStream m a -> MStream m a) -> v (PrimState m) a -> m (v (PrimState m) a)Source
fill :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a -> m (v (PrimState m) a)Source
fillR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a -> m (v (PrimState m) a)Source
accum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Stream (Int, b) -> m ()Source
unstablePartition :: forall m v a. (PrimMonad m, MVector v a) => (a -> Bool) -> v (PrimState m) a -> m IntSource