Copyright  (c) Roman Leshchinskiy 20082010 Alexey Kuleshevich 20202022 Aleksey Khudyakov 20202022 Andrew Lelechenko 20202022 

License  BSDstyle 
Maintainer  Haskell Libraries Team <libraries@haskell.org> 
Stability  experimental 
Portability  nonportable 
Safe Haskell  SafeInferred 
Language  Haskell2010 
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 :: Int > ST s (v s a)
 basicInitialize :: v s a > ST s ()
 basicUnsafeReplicate :: Int > a > ST s (v s a)
 basicUnsafeRead :: v s a > Int > ST s a
 basicUnsafeWrite :: v s a > Int > a > ST s ()
 basicClear :: v s a > ST s ()
 basicSet :: v s a > a > ST s ()
 basicUnsafeCopy :: v s a > v s a > ST s ()
 basicUnsafeMove :: v s a > v s a > ST s ()
 basicUnsafeGrow :: v s a > Int > ST s (v s a)
 length :: MVector v a => v s a > Int
 null :: MVector v a => v s a > Bool
 slice :: (HasCallStack, 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 :: (HasCallStack, 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)
 generate :: (PrimMonad m, MVector v a) => Int > (Int > a) > m (v (PrimState m) a)
 generateM :: (PrimMonad m, MVector v a) => Int > (Int > m a) > m (v (PrimState m) a)
 clone :: (PrimMonad m, MVector v a) => v (PrimState m) a > m (v (PrimState m) a)
 grow :: (HasCallStack, 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 :: (HasCallStack, 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 :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > Int > m a
 readMaybe :: (PrimMonad m, MVector v a) => v (PrimState m) a > Int > m (Maybe a)
 write :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > Int > a > m ()
 modify :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > (a > a) > Int > m ()
 modifyM :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > (a > m a) > Int > m ()
 swap :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > Int > Int > m ()
 exchange :: (HasCallStack, 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 ()
 unsafeModifyM :: (PrimMonad m, MVector v a) => v (PrimState m) a > (a > m 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
 mapM_ :: (PrimMonad m, MVector v a) => (a > m b) > v (PrimState m) a > m ()
 imapM_ :: (PrimMonad m, MVector v a) => (Int > a > m b) > v (PrimState m) a > m ()
 forM_ :: (PrimMonad m, MVector v a) => v (PrimState m) a > (a > m b) > m ()
 iforM_ :: (PrimMonad m, MVector v a) => v (PrimState m) a > (Int > a > m b) > m ()
 foldl :: (PrimMonad m, MVector v a) => (b > a > b) > b > v (PrimState m) a > m b
 foldl' :: (PrimMonad m, MVector v a) => (b > a > b) > b > v (PrimState m) a > m b
 foldM :: (PrimMonad m, MVector v a) => (b > a > m b) > b > v (PrimState m) a > m b
 foldM' :: (PrimMonad m, MVector v a) => (b > a > m b) > b > v (PrimState m) a > m b
 foldr :: (PrimMonad m, MVector v a) => (a > b > b) > b > v (PrimState m) a > m b
 foldr' :: (PrimMonad m, MVector v a) => (a > b > b) > b > v (PrimState m) a > m b
 foldrM :: (PrimMonad m, MVector v a) => (a > b > m b) > b > v (PrimState m) a > m b
 foldrM' :: (PrimMonad m, MVector v a) => (a > b > m b) > b > v (PrimState m) a > m b
 ifoldl :: (PrimMonad m, MVector v a) => (b > Int > a > b) > b > v (PrimState m) a > m b
 ifoldl' :: (PrimMonad m, MVector v a) => (b > Int > a > b) > b > v (PrimState m) a > m b
 ifoldM :: (PrimMonad m, MVector v a) => (b > Int > a > m b) > b > v (PrimState m) a > m b
 ifoldM' :: (PrimMonad m, MVector v a) => (b > Int > a > m b) > b > v (PrimState m) a > m b
 ifoldr :: (PrimMonad m, MVector v a) => (Int > a > b > b) > b > v (PrimState m) a > m b
 ifoldr' :: (PrimMonad m, MVector v a) => (Int > a > b > b) > b > v (PrimState m) a > m b
 ifoldrM :: (PrimMonad m, MVector v a) => (Int > a > b > m b) > b > v (PrimState m) a > m b
 ifoldrM' :: (PrimMonad m, MVector v a) => (Int > a > b > m b) > b > v (PrimState m) a > m b
 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 :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > v (PrimState m) a > m ()
 move :: (HasCallStack, 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 :: forall m v a b u. (HasCallStack, 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 :: forall m v a u. (HasCallStack, 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 Monad m => PrimMonad (m :: Type > Type)
 type family PrimState (m :: Type > Type)
 data RealWorld
Class of mutable vector types
class MVector v a where Source #
Class of mutable vectors parameterised with a primitive state token.
basicLength, basicUnsafeSlice, basicOverlaps, basicUnsafeNew, basicInitialize, basicUnsafeRead, basicUnsafeWrite
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 :: Int > ST s (v s a) Source #
Create a mutable vector of the given length. This method should not be
called directly, use unsafeNew
instead.
basicInitialize :: v s a > ST s () 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 noop.
Since: 0.11.0.0
basicUnsafeReplicate :: Int > a > ST s (v s 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 :: v s a > Int > ST s a Source #
Yield the element at the given position. This method should not be
called directly, use unsafeRead
instead.
basicUnsafeWrite :: v s a > Int > a > ST s () Source #
Replace the element at the given position. This method should not be
called directly, use unsafeWrite
instead.
basicClear :: v s a > ST s () 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 :: v s a > a > ST s () Source #
Set all elements of the vector to the given value. This method should
not be called directly, use set
instead.
:: v s a  target 
> v s a  source 
> ST s () 
Copy a vector. The two vectors may not overlap. This method should not
be called directly, use unsafeCopy
instead.
:: v s a  target 
> v s a  source 
> ST s () 
Move the contents of a vector. The two vectors may overlap. This method
should not be called directly, use unsafeMove
instead.
basicUnsafeGrow :: v s a > Int > ST s (v s 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
:: (HasCallStack, MVector v a)  
=> Int 

> Int 

> v s a  
> v s a 
Yield a part of the mutable vector without copying it. The vector must
contain at least i+n
elements.
init :: MVector v a => v s a > v 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 v a => v s a > v 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 :: MVector v a => Int > v s a > v 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 :: MVector v a => Int > v s a > v 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.
unsafeInit :: MVector v a => v s a > v s a Source #
Same as init
, but doesn't do range checks.
unsafeTail :: MVector v a => v s a > v s a Source #
Same as tail
, but doesn't do range checks.
unsafeTake :: MVector v a => Int > v s a > v 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 :: MVector v a => Int > v s a > v 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 :: (HasCallStack, 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 assumed to be uninitialized. However, the exact semantics depend on the vector implementation. For example, unboxed and storable vectors will create a vector filled with whatever the 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.
generate :: (PrimMonad m, MVector v a) => Int > (Int > a) > m (v (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, MVector v a) => Int > (Int > m a) > m (v (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 v a) => v (PrimState m) a > m (v (PrimState m) a) Source #
Create a copy of a mutable vector.
Growing
grow :: (HasCallStack, 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 an exception is thrown. The semantics of this function
are exactly the same as of 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
:: (PrimMonad m, MVector v a)  
=> v (PrimState m) a  mutable vector to copy from 
> Int  number of elements to grow the vector by (must be nonnegative, 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 bottoms.
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 :: (HasCallStack, 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 :: (HasCallStack, PrimMonad m, MVector v a) => v (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 v a) => v (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 :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > Int > a > m () Source #
Replace the element at the given position.
modify :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > (a > a) > Int > m () Source #
Modify the element at the given position.
modifyM :: (HasCallStack, PrimMonad m, MVector v a) => v (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 :: (HasCallStack, PrimMonad m, MVector v a) => v (PrimState m) a > Int > Int > m () Source #
Swap the elements at the given positions.
exchange :: (HasCallStack, 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.
unsafeModifyM :: (PrimMonad m, MVector v a) => v (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 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.
Folds
mapM_ :: (PrimMonad m, MVector v a) => (a > m b) > v (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, MVector v a) => (Int > a > m b) > v (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 v a) => v (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 v a) => v (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, MVector v a) => (b > a > b) > b > v (PrimState m) a > m b Source #
O(n) Pure left fold.
Since: 0.12.3.0
foldl' :: (PrimMonad m, MVector v a) => (b > a > b) > b > v (PrimState m) a > m b Source #
O(n) Pure left fold with strict accumulator.
Since: 0.12.3.0
foldM :: (PrimMonad m, MVector v a) => (b > a > m b) > b > v (PrimState m) a > m b Source #
O(n) Monadic fold.
Since: 0.12.3.0
foldM' :: (PrimMonad m, MVector v a) => (b > a > m b) > b > v (PrimState m) a > m b Source #
O(n) Monadic fold with strict accumulator.
Since: 0.12.3.0
foldr :: (PrimMonad m, MVector v a) => (a > b > b) > b > v (PrimState m) a > m b Source #
O(n) Pure right fold.
Since: 0.12.3.0
foldr' :: (PrimMonad m, MVector v a) => (a > b > b) > b > v (PrimState m) a > m b Source #
O(n) Pure right fold with strict accumulator.
Since: 0.12.3.0
foldrM :: (PrimMonad m, MVector v a) => (a > b > m b) > b > v (PrimState m) a > m b Source #
O(n) Monadic right fold.
Since: 0.12.3.0
foldrM' :: (PrimMonad m, MVector v a) => (a > b > m b) > b > v (PrimState m) a > m b Source #
O(n) Monadic right fold with strict accumulator.
Since: 0.12.3.0
ifoldl :: (PrimMonad m, MVector v a) => (b > Int > a > b) > b > v (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, MVector v a) => (b > Int > a > b) > b > v (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, MVector v a) => (b > Int > a > m b) > b > v (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, MVector v a) => (b > Int > a > m b) > b > v (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, MVector v a) => (Int > a > b > b) > b > v (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, MVector v a) => (Int > a > b > b) > b > v (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, MVector v a) => (Int > a > b > m b) > b > v (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, MVector v a) => (Int > a > b > m b) > b > v (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 v e) => v (PrimState m) e > m Bool Source #
Compute the (lexicographically) next permutation of the given vector inplace. Returns False when the 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.
:: (HasCallStack, PrimMonad m, MVector v a)  
=> v (PrimState m) a  target 
> v (PrimState m) a  source 
> m () 
Copy a vector. The two vectors must have the same length and may not overlap.
:: (HasCallStack, PrimMonad m, MVector v a)  
=> v (PrimState m) a  target 
> v (PrimState m) a  source 
> m () 
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.
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 :: forall m v a b u. (HasCallStack, 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 #
update :: forall m v a u. (HasCallStack, 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 #
partitionBundle :: (PrimMonad m, MVector v a) => (a > Bool) > Bundle u a > m (v (PrimState m) a, v (PrimState m) a) Source #
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) Source #
Reexports
class Monad m => PrimMonad (m :: Type > Type) #
Class of monads which can perform primitive statetransformer 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: primitive0.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: primitive0.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.