Copyright | (c) Roman Leshchinskiy 2008-2010 Alexey Kuleshevich 2020-2022 Aleksey Khudyakov 2020-2022 Andrew Lelechenko 2020-2022 |
---|---|
License | BSD-style |
Maintainer | Haskell Libraries Team <libraries@haskell.org> |
Stability | experimental |
Portability | non-portable |
Safe Haskell | Safe-Inferred |
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)
- generate :: PrimMonad m => Int -> (Int -> a) -> m (MVector (PrimState m) a)
- generateM :: PrimMonad m => Int -> (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
- readMaybe :: PrimMonad m => MVector (PrimState m) a -> Int -> m (Maybe a)
- write :: PrimMonad m => MVector (PrimState m) a -> Int -> a -> m ()
- modify :: PrimMonad m => MVector (PrimState m) a -> (a -> a) -> Int -> m ()
- modifyM :: PrimMonad m => MVector (PrimState m) a -> (a -> m a) -> Int -> m ()
- swap :: PrimMonad m => MVector (PrimState m) a -> Int -> Int -> m ()
- exchange :: PrimMonad m => MVector (PrimState m) a -> Int -> a -> m a
- 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 ()
- unsafeModifyM :: PrimMonad m => MVector (PrimState m) a -> (a -> m a) -> Int -> m ()
- unsafeSwap :: PrimMonad m => MVector (PrimState m) a -> Int -> Int -> m ()
- unsafeExchange :: PrimMonad m => MVector (PrimState m) a -> Int -> a -> m a
- mapM_ :: PrimMonad m => (a -> m b) -> MVector (PrimState m) a -> m ()
- imapM_ :: PrimMonad m => (Int -> a -> m b) -> MVector (PrimState m) a -> m ()
- forM_ :: PrimMonad m => MVector (PrimState m) a -> (a -> m b) -> m ()
- iforM_ :: PrimMonad m => MVector (PrimState m) a -> (Int -> a -> m b) -> m ()
- foldl :: PrimMonad m => (b -> a -> b) -> b -> MVector (PrimState m) a -> m b
- foldl' :: PrimMonad m => (b -> a -> b) -> b -> MVector (PrimState m) a -> m b
- foldM :: PrimMonad m => (b -> a -> m b) -> b -> MVector (PrimState m) a -> m b
- foldM' :: PrimMonad m => (b -> a -> m b) -> b -> MVector (PrimState m) a -> m b
- foldr :: PrimMonad m => (a -> b -> b) -> b -> MVector (PrimState m) a -> m b
- foldr' :: PrimMonad m => (a -> b -> b) -> b -> MVector (PrimState m) a -> m b
- foldrM :: PrimMonad m => (a -> b -> m b) -> b -> MVector (PrimState m) a -> m b
- foldrM' :: PrimMonad m => (a -> b -> m b) -> b -> MVector (PrimState m) a -> m b
- ifoldl :: PrimMonad m => (b -> Int -> a -> b) -> b -> MVector (PrimState m) a -> m b
- ifoldl' :: PrimMonad m => (b -> Int -> a -> b) -> b -> MVector (PrimState m) a -> m b
- ifoldM :: PrimMonad m => (b -> Int -> a -> m b) -> b -> MVector (PrimState m) a -> m b
- ifoldM' :: PrimMonad m => (b -> Int -> a -> m b) -> b -> MVector (PrimState m) a -> m b
- ifoldr :: PrimMonad m => (Int -> a -> b -> b) -> b -> MVector (PrimState m) a -> m b
- ifoldr' :: PrimMonad m => (Int -> a -> b -> b) -> b -> MVector (PrimState m) a -> m b
- ifoldrM :: PrimMonad m => (Int -> a -> b -> m b) -> b -> MVector (PrimState m) a -> m b
- ifoldrM' :: PrimMonad m => (Int -> a -> b -> m b) -> b -> MVector (PrimState m) a -> m b
- 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)
- class Monad m => PrimMonad (m :: Type -> Type)
- type family PrimState (m :: Type -> Type)
- data RealWorld
Mutable boxed vectors
Mutable boxed vectors keyed on the monad they live in (IO
or
).ST
s
MVector !Int !Int !(MutableArray s a) |
Instances
MVector MVector a Source # | |
Defined in Data.Vector.Mutable basicLength :: MVector s a -> Int Source # basicUnsafeSlice :: Int -> Int -> MVector s a -> MVector s a Source # basicOverlaps :: MVector s a -> MVector s a -> Bool Source # basicUnsafeNew :: Int -> ST s (MVector s a) Source # basicInitialize :: MVector s a -> ST s () Source # basicUnsafeReplicate :: Int -> a -> ST s (MVector s a) Source # basicUnsafeRead :: MVector s a -> Int -> ST s a Source # basicUnsafeWrite :: MVector s a -> Int -> a -> ST s () Source # basicClear :: MVector s a -> ST s () Source # basicSet :: MVector s a -> a -> ST s () Source # basicUnsafeCopy :: MVector s a -> MVector s a -> ST s () Source # basicUnsafeMove :: MVector s a -> MVector s a -> ST s () Source # basicUnsafeGrow :: MVector s a -> Int -> ST s (MVector s a) Source # |
Accessors
Length information
Extracting subvectors
Yield a part of the mutable vector without copying it. The vector must
contain at least i+n
elements.
init :: MVector s a -> MVector s a Source #
Drop the last element of the mutable vector without making a copy. If the vector is empty, an exception is thrown.
tail :: MVector s a -> MVector s a Source #
Drop the first element of the mutable vector without making a copy. If the vector is empty, an exception is thrown.
take :: Int -> MVector s a -> MVector s a Source #
Take the n
first elements of the mutable vector without making a
copy. For negative n
, the empty vector is returned. If n
is larger
than the vector's length, the vector is returned unchanged.
drop :: Int -> MVector s a -> MVector s a Source #
Drop the n
first element of the mutable vector without making a
copy. For negative n
, the vector is returned unchanged. If n
is
larger than the vector's length, the empty vector is returned.
Yield a part of the mutable vector without copying it. No bounds checks are performed.
unsafeTake :: Int -> MVector s a -> MVector s a Source #
Unsafe variant of take
. If n
is out of range, it will
simply create an invalid slice that likely violate memory safety.
unsafeDrop :: Int -> MVector s a -> MVector s a Source #
Unsafe variant of drop
. If n
is out of range, it will
simply create an invalid slice that likely violate memory safety.
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.
generate :: PrimMonad m => Int -> (Int -> a) -> m (MVector (PrimState m) a) Source #
O(n) Create a mutable vector of the given length (0 if the length is negative) and fill it with the results of applying the function to each index. Iteration starts at index 0.
Since: 0.12.3.0
generateM :: PrimMonad m => Int -> (Int -> m a) -> m (MVector (PrimState m) a) Source #
O(n) Create a mutable vector of the given length (0 if the length is negative) and fill it with the results of applying the monadic function to each index. Iteration starts at index 0.
Since: 0.12.3.0
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
non-negative. This has the same semantics as grow
for generic vectors. It differs
from grow
functions for unpacked vectors, however, in that only pointers to
values are copied over, therefore the values themselves will be shared between the
two vectors. This is an important distinction to know about during memory
usage analysis and in case the values themselves are of a mutable type, e.g.
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.freeze 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.freeze mv'
[10,20,888,999,777]>>>
V.freeze 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 non-negative, but
this is not checked. This has the same semantics as unsafeGrow
for generic vectors.
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.
Accessing individual elements
read :: PrimMonad m => MVector (PrimState m) a -> Int -> m a Source #
Yield the element at the given position. Will throw an exception if the index is out of range.
Examples
>>>
import qualified Data.Vector.Mutable as MV
>>>
v <- MV.generate 10 (\x -> x*x)
>>>
MV.read v 3
9
readMaybe :: PrimMonad m => MVector (PrimState m) a -> Int -> m (Maybe a) Source #
Yield the element at the given position. Returns Nothing
if
the index is out of range.
Examples
>>>
import qualified Data.Vector.Mutable as MV
>>>
v <- MV.generate 10 (\x -> x*x)
>>>
MV.readMaybe v 3
Just 9>>>
MV.readMaybe v 13
Nothing
Since: 0.13
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.
modifyM :: PrimMonad m => MVector (PrimState m) a -> (a -> m a) -> Int -> m () Source #
Modify the element at the given position using a monadic function.
Since: 0.12.3.0
swap :: PrimMonad m => MVector (PrimState m) a -> Int -> Int -> m () Source #
Swap the elements at the given positions.
exchange :: PrimMonad m => MVector (PrimState m) a -> Int -> a -> m a Source #
Replace the element at the given position and return the old element.
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.
unsafeModifyM :: PrimMonad m => MVector (PrimState m) a -> (a -> m a) -> Int -> m () Source #
Modify the element at the given position using a monadic function. No bounds checks are performed.
Since: 0.12.3.0
unsafeSwap :: PrimMonad m => MVector (PrimState m) a -> Int -> Int -> m () Source #
Swap the elements at the given positions. No bounds checks are performed.
unsafeExchange :: PrimMonad m => MVector (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.
Folds
mapM_ :: PrimMonad m => (a -> m b) -> MVector (PrimState m) a -> m () Source #
O(n) Apply the monadic action to every element of the vector, discarding the results.
Since: 0.12.3.0
imapM_ :: PrimMonad m => (Int -> a -> m b) -> MVector (PrimState m) a -> m () Source #
O(n) Apply the monadic action to every element of the vector and its index, discarding the results.
Since: 0.12.3.0
forM_ :: PrimMonad m => MVector (PrimState m) a -> (a -> m b) -> m () Source #
O(n) Apply the monadic action to every element of the vector,
discarding the results. It's the same as flip mapM_
.
Since: 0.12.3.0
iforM_ :: PrimMonad m => MVector (PrimState m) a -> (Int -> a -> m b) -> m () Source #
O(n) Apply the monadic action to every element of the vector
and its index, discarding the results. It's the same as flip imapM_
.
Since: 0.12.3.0
foldl :: PrimMonad m => (b -> a -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure left fold.
Since: 0.12.3.0
foldl' :: PrimMonad m => (b -> a -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure left fold with strict accumulator.
Since: 0.12.3.0
foldM :: PrimMonad m => (b -> a -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic fold.
Since: 0.12.3.0
foldM' :: PrimMonad m => (b -> a -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic fold with strict accumulator.
Since: 0.12.3.0
foldr :: PrimMonad m => (a -> b -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure right fold.
Since: 0.12.3.0
foldr' :: PrimMonad m => (a -> b -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure right fold with strict accumulator.
Since: 0.12.3.0
foldrM :: PrimMonad m => (a -> b -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic right fold.
Since: 0.12.3.0
foldrM' :: PrimMonad m => (a -> b -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic right fold with strict accumulator.
Since: 0.12.3.0
ifoldl :: PrimMonad m => (b -> Int -> a -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure left fold using a function applied to each element and its index.
Since: 0.12.3.0
ifoldl' :: PrimMonad m => (b -> Int -> a -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure left fold with strict accumulator using a function applied to each element and its index.
Since: 0.12.3.0
ifoldM :: PrimMonad m => (b -> Int -> a -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic fold using a function applied to each element and its index.
Since: 0.12.3.0
ifoldM' :: PrimMonad m => (b -> Int -> a -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic fold with strict accumulator using a function applied to each element and its index.
Since: 0.12.3.0
ifoldr :: PrimMonad m => (Int -> a -> b -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure right fold using a function applied to each element and its index.
Since: 0.12.3.0
ifoldr' :: PrimMonad m => (Int -> a -> b -> b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Pure right fold with strict accumulator using a function applied to each element and its index.
Since: 0.12.3.0
ifoldrM :: PrimMonad m => (Int -> a -> b -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic right fold using a function applied to each element and its index.
Since: 0.12.3.0
ifoldrM' :: PrimMonad m => (Int -> a -> b -> m b) -> b -> MVector (PrimState m) a -> m b Source #
O(n) Monadic right fold with strict accumulator using a function applied to each element and its index.
Since: 0.12.3.0
Modifying vectors
nextPermutation :: (PrimMonad m, Ord e) => MVector (PrimState m) e -> m Bool Source #
Compute the (lexicographically) next permutation of the given vector in-place. Returns False when the 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, but 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
Re-exports
class Monad m => PrimMonad (m :: Type -> Type) #
Class of monads which can perform primitive state-transformer actions.
Instances
PrimMonad IO | |
PrimMonad (ST s) | |
PrimMonad (ST s) | |
PrimMonad m => PrimMonad (ListT m) | |
PrimMonad m => PrimMonad (MaybeT m) | |
(Monoid w, PrimMonad m) => PrimMonad (AccumT w m) | Since: primitive-0.6.3.0 |
(Error e, PrimMonad m) => PrimMonad (ErrorT e m) | |
PrimMonad m => PrimMonad (ExceptT e m) | |
PrimMonad m => PrimMonad (IdentityT m) | |
PrimMonad m => PrimMonad (ReaderT r m) | |
PrimMonad m => PrimMonad (SelectT r m) | |
PrimMonad m => PrimMonad (StateT s m) | |
PrimMonad m => PrimMonad (StateT s m) | |
(Monoid w, PrimMonad m) => PrimMonad (WriterT w m) | |
(Monoid w, PrimMonad m) => PrimMonad (WriterT w m) | |
(Monoid w, PrimMonad m) => PrimMonad (WriterT w m) | |
PrimMonad m => PrimMonad (ContT r m) | Since: primitive-0.6.3.0 |
(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m) | |
(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m) | |
(Monoid w, PrimMonad m) => PrimMonad (RWST r w s m) | |
type family PrimState (m :: Type -> Type) #
State token type.