| Copyright | (c) Roman Leshchinskiy 2008-2010 |
|---|---|
| License | BSD-style |
| Maintainer | Roman Leshchinskiy <rl@cse.unsw.edu.au> |
| Stability | experimental |
| Portability | non-portable |
| Safe Haskell | None |
| Language | Haskell2010 |
Data.Vector.Generic.Mutable
Description
Generic interface to mutable vectors
Synopsis
- class MVector v a where
- basicLength :: v s a -> Int
- basicUnsafeSlice :: Int -> Int -> v s a -> v s a
- basicOverlaps :: v s a -> v s a -> Bool
- basicUnsafeNew :: PrimMonad m => Int -> m (v (PrimState m) a)
- basicInitialize :: PrimMonad m => v (PrimState m) a -> m ()
- basicUnsafeReplicate :: PrimMonad m => Int -> a -> m (v (PrimState m) a)
- basicUnsafeRead :: PrimMonad m => v (PrimState m) a -> Int -> m a
- basicUnsafeWrite :: PrimMonad m => v (PrimState m) a -> Int -> a -> m ()
- basicClear :: PrimMonad m => v (PrimState m) a -> m ()
- basicSet :: PrimMonad m => v (PrimState m) a -> a -> m ()
- basicUnsafeCopy :: PrimMonad m => v (PrimState m) a -> v (PrimState m) a -> m ()
- basicUnsafeMove :: PrimMonad m => v (PrimState m) a -> v (PrimState m) a -> m ()
- basicUnsafeGrow :: PrimMonad m => v (PrimState m) a -> Int -> m (v (PrimState m) 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)
- unsafeSlice :: MVector v a => Int -> Int -> v s a -> v s a
- unsafeInit :: MVector v a => v s a -> v s a
- unsafeTail :: MVector v a => v s a -> v s a
- unsafeTake :: MVector v a => Int -> v s a -> v s a
- unsafeDrop :: MVector v a => Int -> 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)
- unsafeNew :: (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)
- unsafeGrow :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a)
- growFront :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a)
- unsafeGrowFront :: (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 ()
- modify :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> a) -> Int -> m ()
- swap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m ()
- exchange :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m a
- unsafeRead :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m a
- unsafeWrite :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m ()
- unsafeModify :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> a) -> Int -> m ()
- unsafeSwap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m ()
- unsafeExchange :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m a
- nextPermutation :: (PrimMonad m, Ord e, MVector v e) => v (PrimState m) e -> m Bool
- 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 ()
- unsafeCopy :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()
- unsafeMove :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()
- mstream :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a
- mstreamR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a
- unstream :: (PrimMonad m, MVector v a) => Bundle u a -> m (v (PrimState m) a)
- unstreamR :: (PrimMonad m, MVector v a) => Bundle u a -> m (v (PrimState m) a)
- vunstream :: (PrimMonad m, Vector v a) => Bundle v a -> m (Mutable v (PrimState m) a)
- munstream :: (PrimMonad m, MVector v a) => MBundle m u a -> m (v (PrimState m) a)
- munstreamR :: (PrimMonad m, MVector v a) => MBundle m u a -> m (v (PrimState m) a)
- transform :: (PrimMonad m, MVector v a) => (Stream m a -> Stream m a) -> v (PrimState m) a -> m (v (PrimState m) a)
- transformR :: (PrimMonad m, MVector v a) => (Stream m a -> Stream m a) -> v (PrimState m) a -> m (v (PrimState m) a)
- fill :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a -> m (v (PrimState m) a)
- fillR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a -> m (v (PrimState m) a)
- unsafeAccum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Bundle u (Int, b) -> m ()
- accum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Bundle u (Int, b) -> m ()
- unsafeUpdate :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Bundle u (Int, a) -> m ()
- update :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Bundle u (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
- unstablePartitionBundle :: (PrimMonad m, MVector v a) => (a -> Bool) -> Bundle u a -> m (v (PrimState m) a, v (PrimState m) a)
- partitionBundle :: (PrimMonad m, MVector v a) => (a -> Bool) -> Bundle u a -> m (v (PrimState m) a, v (PrimState m) a)
- partitionWithBundle :: (PrimMonad m, MVector v a, MVector v b, MVector v c) => (a -> Either b c) -> Bundle u a -> m (v (PrimState m) b, v (PrimState m) c)
Class of mutable vector types
class MVector v a where Source #
Class of mutable vectors parametrised with a primitive state token.
Minimal complete definition
basicLength, basicUnsafeSlice, basicOverlaps, basicUnsafeNew, basicInitialize, basicUnsafeRead, basicUnsafeWrite
Methods
basicLength :: v s a -> Int Source #
Length of the mutable vector. This method should not be
called directly, use length instead.
Yield a part of the mutable vector without copying it. This method
should not be called directly, use unsafeSlice instead.
basicOverlaps :: v s a -> v s a -> Bool Source #
Check whether two vectors overlap. This method should not be
called directly, use overlaps instead.
basicUnsafeNew :: PrimMonad m => Int -> m (v (PrimState m) a) Source #
Create a mutable vector of the given length. This method should not be
called directly, use unsafeNew instead.
basicInitialize :: PrimMonad m => v (PrimState m) a -> m () Source #
Initialize a vector to a standard value. This is intended to be called as part of the safe new operation (and similar operations), to properly blank the newly allocated memory if necessary.
Vectors that are necessarily initialized as part of creation may implement this as a no-op.
Since: 0.11.0.0
basicUnsafeReplicate :: PrimMonad m => Int -> a -> m (v (PrimState m) a) Source #
Create a mutable vector of the given length and fill it with an
initial value. This method should not be called directly, use
replicate instead.
basicUnsafeRead :: PrimMonad m => v (PrimState m) a -> Int -> m a Source #
Yield the element at the given position. This method should not be
called directly, use unsafeRead instead.
basicUnsafeWrite :: PrimMonad m => v (PrimState m) a -> Int -> a -> m () Source #
Replace the element at the given position. This method should not be
called directly, use unsafeWrite instead.
basicClear :: PrimMonad m => 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. This method should not be called directly, use clear instead.
basicSet :: PrimMonad m => v (PrimState m) a -> a -> m () Source #
Set all elements of the vector to the given value. This method should
not be called directly, use set instead.
Copy a vector. The two vectors may not overlap. This method should not
be called directly, use unsafeCopy instead.
Move the contents of a vector. The two vectors may overlap. This method
should not be called directly, use unsafeMove instead.
basicUnsafeGrow :: PrimMonad m => v (PrimState m) a -> Int -> m (v (PrimState m) a) Source #
Grow a vector by the given number of elements. Allocates a new vector and
copies all of the elements over starting at 0 index. This method should not
be called directly, use grow/unsafeGrow instead.
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 v a => v s a -> v s a Source #
unsafeTail :: MVector v a => v s a -> v s a Source #
unsafeTake :: MVector v a => Int -> v s a -> v s a Source #
unsafeDrop :: MVector v a => Int -> v s a -> v s a Source #
Overlapping
Construction
Initialisation
new :: (PrimMonad m, MVector v a) => Int -> m (v (PrimState m) a) Source #
Create a mutable vector of the given length.
unsafeNew :: (PrimMonad m, MVector v a) => Int -> m (v (PrimState m) a) Source #
Create a mutable vector of the given length. The vector content should be presumed uninitialized. However exact semantics depends on vector implementation. For example unboxed and storable vectors will create vector filled with whatever underlying memory buffer happens to contain, while boxed vector's elements are initialized to bottoms which will throw exception when evaluated.
Since: 0.4
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 not be
negative otherwise error is thrown. Semantics of this function is exactly the
same as unsafeGrow, except that it will initialize the newly
allocated memory first.
It is important to note that mutating the returned vector will not affect the
vector that was used as a source. In other words it does not, nor will it
ever have the semantics of realloc from C.
grow mv 0 === clone mv
Since: 0.4.0
Arguments
| :: (PrimMonad m, MVector v a) | |
| => v (PrimState m) a | A mutable vector to copy the data from. |
| -> Int | Number of elements to grow the vector by. It must be non-negative but this is not checked. |
| -> m (v (PrimState m) a) |
Grow a vector by allocating a new mutable vector of the same size plus the
the given number of elements and copying all the data over to the new vector
starting at its beginning. The newly allocated memory is not initialized and
the extra space at the end will likely contain garbage data or uninitialzed
error. Use unsafeGrowFront to make the extra space available in the front
of the new vector.
It is important to note that mutating the returned vector will not affect
elements of the vector that was used as a source. In other words it does not,
nor will it ever have the semantics of realloc from C. Keep in mind,
however, that values themselves can be of a mutable type
(eg. Ptr), in which case it would be possible to affect values
stored in both vectors.
unsafeGrow mv 0 === clone mv
Since: 0.4.0
growFront :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a) Source #
Same as grow, except that it copies data towards the end of the newly
allocated vector making extra space available at the beginning.
Since: 0.11.0.0
unsafeGrowFront :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a) Source #
Same as unsafeGrow, except that it copies data towards the end of the
newly allocated vector making extra space available at the beginning.
Since: 0.11.0.0
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 a Source #
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.
modify :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> a) -> Int -> m () Source #
Modify 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.
exchange :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m a Source #
Replace the element at the given position and return the old element.
unsafeRead :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m a Source #
Yield the element at the given position. No bounds checks are performed.
unsafeWrite :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m () Source #
Replace the element at the given position. No bounds checks are performed.
unsafeModify :: (PrimMonad m, MVector v a) => v (PrimState m) a -> (a -> a) -> Int -> m () Source #
Modify the element at the given position. No bounds checks are performed.
unsafeSwap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m () Source #
Swap the elements at the given positions. No bounds checks are performed.
unsafeExchange :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m a Source #
Replace the element at the given position and return the old element. No bounds checks are performed.
Modifying vectors
nextPermutation :: (PrimMonad m, Ord e, MVector v e) => v (PrimState m) e -> m Bool Source #
Compute the next (lexicographically) permutation of given vector in-place. Returns False when input is the last permutation
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 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.
Internal operations
munstream :: (PrimMonad m, MVector v a) => MBundle m u 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) => MBundle m u 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) => (Stream m a -> Stream m a) -> v (PrimState m) a -> m (v (PrimState m) a) Source #
transformR :: (PrimMonad m, MVector v a) => (Stream m a -> Stream m a) -> v (PrimState m) a -> m (v (PrimState m) a) Source #
fill :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a -> m (v (PrimState m) a) Source #
fillR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a -> m (v (PrimState m) a) Source #
unsafeAccum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Bundle u (Int, b) -> m () Source #
accum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Bundle u (Int, b) -> m () Source #
unsafeUpdate :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Bundle u (Int, a) -> m () Source #
unstablePartition :: forall m v a. (PrimMonad m, MVector v a) => (a -> Bool) -> v (PrimState m) a -> m Int Source #
unstablePartitionBundle :: (PrimMonad m, MVector v a) => (a -> Bool) -> Bundle u a -> m (v (PrimState m) a, v (PrimState m) a) Source #