vector-0.12.2.0: Efficient Arrays
Copyright(c) Roman Leshchinskiy 2008-2010
LicenseBSD-style
MaintainerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Data.Vector.Generic.Mutable

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.

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.

Since: 0.11.0.0

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

Instances details
MVector MVector a Source # 
Instance details

Defined in Data.Vector.Mutable

Prim a => MVector MVector a Source # 
Instance details

Defined in Data.Vector.Primitive.Mutable

Storable a => MVector MVector a Source # 
Instance details

Defined in Data.Vector.Storable.Mutable

MVector MVector Bool Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Char Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Double Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Float Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Int Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Int8 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Int16 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Int32 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Int64 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Word Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Word8 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Word16 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Word32 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Word64 Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector () Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector All Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

MVector MVector Any Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Complex a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Min a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Max a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (First a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Last a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (WrappedMonoid a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Identity a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Dual a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Sum a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Product a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Unbox a => MVector MVector (Down a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

(Unbox a, Unbox b) => MVector MVector (a, b) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (a, b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (a, b) -> MVector s (a, b) Source #

basicOverlaps :: MVector s (a, b) -> MVector s (a, b) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (a, b)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (a, b) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> (a, b) -> m (MVector (PrimState m) (a, b)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (a, b) -> Int -> m (a, b) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (a, b) -> Int -> (a, b) -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (a, b) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (a, b) -> (a, b) -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (a, b) -> MVector (PrimState m) (a, b) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (a, b) -> MVector (PrimState m) (a, b) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (a, b) -> Int -> m (MVector (PrimState m) (a, b)) Source #

(Unbox a, Unbox b) => MVector MVector (Arg a b) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (Arg a b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (Arg a b) -> MVector s (Arg a b) Source #

basicOverlaps :: MVector s (Arg a b) -> MVector s (Arg a b) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (Arg a b)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (Arg a b) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> Arg a b -> m (MVector (PrimState m) (Arg a b)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (Arg a b) -> Int -> m (Arg a b) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (Arg a b) -> Int -> Arg a b -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (Arg a b) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (Arg a b) -> Arg a b -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (Arg a b) -> MVector (PrimState m) (Arg a b) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (Arg a b) -> MVector (PrimState m) (Arg a b) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (Arg a b) -> Int -> m (MVector (PrimState m) (Arg a b)) Source #

(Unbox a, Unbox b, Unbox c) => MVector MVector (a, b, c) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (a, b, c) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (a, b, c) -> MVector s (a, b, c) Source #

basicOverlaps :: MVector s (a, b, c) -> MVector s (a, b, c) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (a, b, c)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (a, b, c) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> (a, b, c) -> m (MVector (PrimState m) (a, b, c)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (a, b, c) -> Int -> m (a, b, c) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (a, b, c) -> Int -> (a, b, c) -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (a, b, c) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (a, b, c) -> (a, b, c) -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (a, b, c) -> MVector (PrimState m) (a, b, c) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (a, b, c) -> MVector (PrimState m) (a, b, c) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (a, b, c) -> Int -> m (MVector (PrimState m) (a, b, c)) Source #

Unbox a => MVector MVector (Const a b) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (Const a b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (Const a b) -> MVector s (Const a b) Source #

basicOverlaps :: MVector s (Const a b) -> MVector s (Const a b) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (Const a b)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (Const a b) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> Const a b -> m (MVector (PrimState m) (Const a b)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (Const a b) -> Int -> m (Const a b) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (Const a b) -> Int -> Const a b -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (Const a b) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (Const a b) -> Const a b -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (Const a b) -> MVector (PrimState m) (Const a b) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (Const a b) -> MVector (PrimState m) (Const a b) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (Const a b) -> Int -> m (MVector (PrimState m) (Const a b)) Source #

Unbox (f a) => MVector MVector (Alt f a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (Alt f a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (Alt f a) -> MVector s (Alt f a) Source #

basicOverlaps :: MVector s (Alt f a) -> MVector s (Alt f a) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (Alt f a)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (Alt f a) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> Alt f a -> m (MVector (PrimState m) (Alt f a)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (Alt f a) -> Int -> m (Alt f a) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (Alt f a) -> Int -> Alt f a -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (Alt f a) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (Alt f a) -> Alt f a -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (Alt f a) -> MVector (PrimState m) (Alt f a) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (Alt f a) -> MVector (PrimState m) (Alt f a) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (Alt f a) -> Int -> m (MVector (PrimState m) (Alt f a)) Source #

(Unbox a, Unbox b, Unbox c, Unbox d) => MVector MVector (a, b, c, d) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (a, b, c, d) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (a, b, c, d) -> MVector s (a, b, c, d) Source #

basicOverlaps :: MVector s (a, b, c, d) -> MVector s (a, b, c, d) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (a, b, c, d)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> (a, b, c, d) -> m (MVector (PrimState m) (a, b, c, d)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> Int -> m (a, b, c, d) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> Int -> (a, b, c, d) -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> (a, b, c, d) -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> MVector (PrimState m) (a, b, c, d) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> MVector (PrimState m) (a, b, c, d) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (a, b, c, d) -> Int -> m (MVector (PrimState m) (a, b, c, d)) Source #

(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => MVector MVector (a, b, c, d, e) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (a, b, c, d, e) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (a, b, c, d, e) -> MVector s (a, b, c, d, e) Source #

basicOverlaps :: MVector s (a, b, c, d, e) -> MVector s (a, b, c, d, e) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (a, b, c, d, e)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> (a, b, c, d, e) -> m (MVector (PrimState m) (a, b, c, d, e)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> Int -> m (a, b, c, d, e) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> Int -> (a, b, c, d, e) -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> (a, b, c, d, e) -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> MVector (PrimState m) (a, b, c, d, e) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> MVector (PrimState m) (a, b, c, d, e) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e) -> Int -> m (MVector (PrimState m) (a, b, c, d, e)) Source #

Unbox (f (g a)) => MVector MVector (Compose f g a) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (Compose f g a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (Compose f g a) -> MVector s (Compose f g a) Source #

basicOverlaps :: MVector s (Compose f g a) -> MVector s (Compose f g a) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (Compose f g a)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> Compose f g a -> m (MVector (PrimState m) (Compose f g a)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> Int -> m (Compose f g a) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> Int -> Compose f g a -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> Compose f g a -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> MVector (PrimState m) (Compose f g a) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> MVector (PrimState m) (Compose f g a) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (Compose f g a) -> Int -> m (MVector (PrimState m) (Compose f g a)) Source #

(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => MVector MVector (a, b, c, d, e, f) Source # 
Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicLength :: MVector s (a, b, c, d, e, f) -> Int Source #

basicUnsafeSlice :: Int -> Int -> MVector s (a, b, c, d, e, f) -> MVector s (a, b, c, d, e, f) Source #

basicOverlaps :: MVector s (a, b, c, d, e, f) -> MVector s (a, b, c, d, e, f) -> Bool Source #

basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) (a, b, c, d, e, f)) Source #

basicInitialize :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> m () Source #

basicUnsafeReplicate :: PrimMonad m => Int -> (a, b, c, d, e, f) -> m (MVector (PrimState m) (a, b, c, d, e, f)) Source #

basicUnsafeRead :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> Int -> m (a, b, c, d, e, f) Source #

basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> Int -> (a, b, c, d, e, f) -> m () Source #

basicClear :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> m () Source #

basicSet :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> (a, b, c, d, e, f) -> m () Source #

basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> MVector (PrimState m) (a, b, c, d, e, f) -> m () Source #

basicUnsafeMove :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> MVector (PrimState m) (a, b, c, d, e, f) -> m () Source #

basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) (a, b, c, d, e, f) -> Int -> m (MVector (PrimState m) (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 Source #

Arguments

:: MVector v a 
=> Int

i starting index

-> Int

n length

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

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 vector content should be presumed uninitialized. However exact semantics depends on vector implementation. For example unboxed and storable vectors will create vector filled with whatever 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.

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 not be negative otherwise error is thrown. Semantics of this function is exactly the same as 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

unsafeGrow Source #

Arguments

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

A mutable vector to copy the data from.

-> Int

Number of elements to grow the vector by. It must be non-negative 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 uninitialzed error. 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 :: (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 :: (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 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.

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.

Modifying vectors

nextPermutation :: (PrimMonad m, Ord e, MVector v e) => v (PrimState m) e -> m Bool Source #

Compute the next (lexicographically) permutation of given vector in-place. Returns False when 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.

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

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

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 #

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 #