|
Data.Vector.Storable.Mutable | Portability | non-portable | Stability | experimental | Maintainer | Roman Leshchinskiy <rl@cse.unsw.edu.au> |
|
|
|
|
|
Description |
Mutable vectors based on Storable.
|
|
Synopsis |
|
data MVector s a = MVector !(Ptr a) !Int !(ForeignPtr a) | | type IOVector = MVector RealWorld | | type STVector s = MVector s | | Storable (sizeOf, alignment, peekElemOff, pokeElemOff, peekByteOff, pokeByteOff, peek, poke) | | length :: Storable a => MVector s a -> Int | | overlaps :: Storable a => MVector s a -> MVector s a -> Bool | | slice :: Storable a => Int -> Int -> MVector s a -> MVector s a | | new :: (PrimMonad m, Storable a) => Int -> m (MVector (PrimState m) a) | | newWith :: (PrimMonad m, Storable a) => Int -> a -> m (MVector (PrimState m) a) | | read :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m a | | write :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> a -> m () | | swap :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> Int -> m () | | clear :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> m () | | set :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> a -> m () | | copy :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> MVector (PrimState m) a -> m () | | grow :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m (MVector (PrimState m) a) | | unsafeSlice :: Storable a => Int -> Int -> MVector s a -> MVector s a | | unsafeNew :: (PrimMonad m, Storable a) => Int -> m (MVector (PrimState m) a) | | unsafeNewWith :: (PrimMonad m, Storable a) => Int -> a -> m (MVector (PrimState m) a) | | unsafeRead :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m a | | unsafeWrite :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> a -> m () | | unsafeSwap :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> Int -> m () | | unsafeCopy :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> MVector (PrimState m) a -> m () | | unsafeGrow :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m (MVector (PrimState m) a) | | unsafeFromForeignPtr :: Storable a => ForeignPtr a -> Int -> Int -> MVector s a | | unsafeToForeignPtr :: Storable a => MVector s a -> (ForeignPtr a, Int, Int) | | unsafeWith :: Storable a => IOVector a -> (Ptr a -> IO b) -> IO b |
|
|
|
Mutable vectors of Storable types
|
|
|
Mutable Storable-based vectors
| Constructors | | Instances | |
|
|
|
|
|
|
Storable (sizeOf, alignment, peekElemOff, pokeElemOff, peekByteOff, pokeByteOff, peek, poke) |
|
Operations on mutable vectors
|
|
|
Length of the mutable vector.
|
|
|
|
|
Yield a part of the mutable vector without copying it.
|
|
|
Create a mutable vector of the given length.
|
|
|
Create a mutable vector of the given length and fill it with an
initial value.
|
|
|
Yield the element at the given position.
|
|
|
Replace the element at the given position.
|
|
|
Swap the elements at the given positions.
|
|
|
Reset all elements of the vector to some undefined value, clearing all
references to external objects. This is usually a noop for unboxed vectors.
|
|
|
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.
|
|
|
Grow a vector by the given number of elements. The number must be
positive.
|
|
Unsafe operations
|
|
|
:: Storable a | | => Int | starting index
| -> Int | length of the slice
| -> MVector s a | | -> MVector s a | | Yield a part of the mutable vector without copying it. No bounds checks
are performed.
|
|
|
|
Create a mutable vector of the given length. The length is not checked.
|
|
|
Create a mutable vector of the given length and fill it with an
initial value. The length is not checked.
|
|
|
Yield the element at the given position. No bounds checks are performed.
|
|
|
Replace the element at the given position. No bounds checks are performed.
|
|
|
Swap the elements at the given positions. No bounds checks are performed.
|
|
|
|
|
|
Grow a vector by the given number of elements. The number must be
positive but this is not checked.
|
|
Accessing the underlying memory
|
|
|
:: Storable a | | => ForeignPtr a | pointer
| -> Int | offset
| -> Int | length
| -> MVector s a | | Create a mutable vector from a ForeignPtr with an offset and a length.
Modifying data through the ForeignPtr afterwards is unsafe if the vector
could have been frozen before the modification.
|
|
|
|
Yield the underlying ForeignPtr together with the offset to the data
and its length. Modifying the data through the ForeignPtr is
unsafe if the vector could have frozen before the modification.
|
|
|
Pass a pointer to the vector's data to the IO action. Modifying data
through the pointer is unsafe if the vector could have been frozen before
the modification.
|
|
Produced by Haddock version 2.4.2 |