Mutable boxed vectors keyed on the monad they live in (IO or ST s).

Length of the mutable vector.

Check whether the vector is empty.

Yield a part of the mutable vector without copying it. The vector must contain at least i+n elements.

Drop the last element of the mutable vector without making a copy. If the vector is empty, an exception is thrown.

Drop the first element of the mutable vector without making a copy. If the vector is empty, an exception is thrown.

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 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.

O(1) Split the mutable vector into the first n elements and the remainder, without copying.

Note that splitAt n v is equivalent to (take n v, drop n v), but slightly more efficient.

Yield a part of the mutable vector without copying it. No bounds checks are performed.

Same as init, but doesn't do range checks.

Same as tail, but doesn't do range checks.

Unsafe variant of take. If n is out of range, it will simply create an invalid slice that likely violate memory safety.

Unsafe variant of drop. If n is out of range, it will simply create an invalid slice that likely violate memory safety.

Check whether two vectors overlap.

Create a mutable vector of the given length.

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

Create a mutable vector of the given length (0 if the length is negative) and fill it with an initial value.

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.

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

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

Create a copy of a mutable vector.

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

>>> MV.write mv' 3 999
>>> MV.write mv' 4 777
>>> V.freeze mv'
[10,20,30,999,777]

>>> MV.write mv' 2 888
>>> V.freeze mv'
[10,20,888,999,777]
>>> V.freeze mv
[10,20,30]

Since: 0.5

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

Reset all elements of the vector to some undefined value, clearing all references to external objects.

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

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

Replace the element at the given position.

Modify the element at the given position.

Modify the element at the given position using a monadic function.

Since: 0.12.3.0

Swap the elements at the given positions.

Replace the element at the given position and return the old element.

Yield the element at the given position. No bounds checks are performed.

Replace the element at the given position. No bounds checks are performed.

Modify the element at the given position. No bounds checks are performed.

Modify the element at the given position using a monadic function. No bounds checks are performed.

Since: 0.12.3.0

Swap the elements at the given positions. No bounds checks are performed.

Replace the element at the given position and return the old element. No bounds checks are performed.

O(n) Apply the monadic action to every element of the vector, discarding the results.

Since: 0.12.3.0

O(n) Apply the monadic action to every element of the vector and its index, discarding the results.

Since: 0.12.3.0

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

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

O(n) Pure left fold.

Since: 0.12.3.0

O(n) Pure left fold with strict accumulator.

Since: 0.12.3.0

O(n) Monadic fold.

Since: 0.12.3.0

O(n) Monadic fold with strict accumulator.

Since: 0.12.3.0

O(n) Pure right fold.

Since: 0.12.3.0

O(n) Pure right fold with strict accumulator.

Since: 0.12.3.0

O(n) Monadic right fold.

Since: 0.12.3.0

O(n) Monadic right fold with strict accumulator.

Since: 0.12.3.0

O(n) Pure left fold using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Pure left fold with strict accumulator using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Monadic fold using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Monadic fold with strict accumulator using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Pure right fold using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Pure right fold with strict accumulator using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Monadic right fold using a function applied to each element and its index.

Since: 0.12.3.0

O(n) Monadic right fold with strict accumulator using a function applied to each element and its index.

Since: 0.12.3.0

Compute the (lexicographically) next permutation of the given vector in-place. Returns False when the input is the last permutation.

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.

O(n) Make a copy of a mutable array to a new mutable vector.

Since: 0.12.2.0

O(n) Make a copy of a mutable vector into a new mutable array.

Since: 0.12.2.0

Class of monads which can perform primitive state-transformer actions.

State token type.

RealWorld is deeply magical. It is primitive, but it is not unlifted (hence ptrArg). We never manipulate values of type RealWorld; it's only used in the type system, to parameterise State#.