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

Contents

Class of mutable vector types
Accessors
Construction
Accessing individual elements
Modifying vectors
- Filling and copying
Internal operations

Description

Generic interface to mutable vectors

Synopsis

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.

basicUnsafeSlice Source

Arguments

:: Int	starting index
-> Int	length of the slice
-> v s a
-> v s a

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.

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.

basicUnsafeCopy Source

Arguments

:: PrimMonad m
=> v (PrimState m) a	target
-> v (PrimState m) a	source
-> m ()

Copy a vector. The two vectors may not overlap. This method should not be called directly, use unsafeCopy instead.

basicUnsafeMove Source

Arguments

:: PrimMonad m
=> v (PrimState m) a	target
-> v (PrimState m) a	source
-> m ()

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. This method should not be called directly, use unsafeGrow instead.

Instances

Prim a => MVector MVector a Source
Storable a => MVector MVector a Source
MVector MVector Bool Source
MVector MVector Char Source
MVector MVector Double Source
MVector MVector Float Source
MVector MVector Int Source
MVector MVector Int8 Source
MVector MVector Int16 Source
MVector MVector Int32 Source
MVector MVector Int64 Source
MVector MVector Word Source
MVector MVector Word8 Source
MVector MVector Word16 Source
MVector MVector Word32 Source
MVector MVector Word64 Source
MVector MVector () Source
MVector MVector a Source
(RealFloat a, Unbox a) => MVector MVector (Complex a) Source
(Unbox a, Unbox b) => MVector MVector (a, b) Source
(Unbox a, Unbox b, Unbox c) => MVector MVector (a, b, c) Source
(Unbox a, Unbox b, Unbox c, Unbox d) => MVector MVector (a, b, c, d) Source
(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => MVector MVector (a, b, c, d, e) Source
(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => MVector MVector (a, b, c, d, e, f) Source

Accessors

Length information

length :: MVector v a => v s a -> Int Source

Length of the mutable vector.

null :: MVector v a => v s a -> Bool Source

Check whether the vector is empty

Extracting subvectors

slice :: MVector v a => Int -> Int -> v s a -> v s a Source

Yield a part of the mutable vector without copying it.

init :: MVector v a => v s a -> v s a Source

tail :: MVector v a => v s a -> v s a Source

take :: MVector v a => Int -> v s a -> v s a Source

drop :: MVector v a => Int -> v s a -> v s a Source

splitAt :: MVector v a => Int -> v s a -> (v s a, v s a) Source

unsafeSlice Source

Arguments

:: MVector v a
=> Int	starting index
-> Int	length of the slice
-> v s a
-> v s a

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

overlaps :: MVector v a => v s a -> v s a -> Bool Source

Check whether two vectors overlap.

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 length is not checked.

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

unsafeGrow :: (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 be positive but this is not checked.

growFront :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a) Source

unsafeGrowFront :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m (v (PrimState m) a) Source

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 give 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 give position and return the old element. No bounds checks are performed.

Modifying vectors

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 :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m () Source

Copy a vector. The two vectors must have the same length and may not overlap.

move :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m () Source

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.

unsafeCopy Source

Arguments

:: (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. This is not checked.

unsafeMove Source

Arguments

:: (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, 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

mstream :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a Source

mstreamR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream m a Source

unstream :: (PrimMonad m, MVector v a) => Bundle u a -> m (v (PrimState m) a) Source

Create a new mutable vector and fill it with elements from the Bundle. The vector will grow exponentially if the maximum size of the Bundle is unknown.

unstreamR :: (PrimMonad m, MVector v a) => Bundle u a -> m (v (PrimState m) a) Source

Create a new mutable vector and fill it with elements from the Bundle from right to left. The vector will grow exponentially if the maximum size of the Bundle is unknown.

vunstream :: (PrimMonad m, Vector v a) => Bundle v a -> m (Mutable v (PrimState m) a) Source

Create a new mutable vector and fill it with elements from the Bundle. The vector will grow exponentially if the maximum size of the Bundle is unknown.

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

update :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Bundle u (Int, a) -> m () Source

reverse :: (PrimMonad m, MVector v a) => v (PrimState m) 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