vector-0.10.0.1: Efficient Arrays

Portabilitynon-portable
Stabilityexperimental
MaintainerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Safe HaskellNone

Data.Vector.Storable.Mutable

Contents

Description

Mutable vectors based on Storable.

Synopsis

Mutable vectors of Storable types

data MVector s a Source

Mutable Storable-based vectors

Constructors

MVector !Int !(ForeignPtr a) 

Instances

Typeable2 MVector 
Storable a => MVector MVector a 
NFData (MVector s a) 

type IOVector = MVector RealWorldSource

class Storable a

Instances

Storable Bool 
Storable Char 
Storable Double 
Storable Float 
Storable Int 
Storable Int8 
Storable Int16 
Storable Int32 
Storable Int64 
Storable Word 
Storable Word8 
Storable Word16 
Storable Word32 
Storable Word64 
Storable Fingerprint 
Storable WordPtr 
Storable IntPtr 
Storable CSize 
Storable CInt 
Storable CWchar 
Storable CUShort 
Storable CUSeconds 
Storable CULong 
Storable CULLong 
Storable CUIntPtr 
Storable CUIntMax 
Storable CUInt 
Storable CUChar 
Storable CTime 
Storable CSigAtomic 
Storable CShort 
Storable CSUSeconds 
Storable CSChar 
Storable CPtrdiff 
Storable CLong 
Storable CLLong 
Storable CIntPtr 
Storable CIntMax 
Storable CFloat 
Storable CDouble 
Storable CClock 
Storable CChar 
Storable (StablePtr a) 
Storable (Ptr a) 
Storable (FunPtr a) 

Accessors

Length information

length :: Storable a => MVector s a -> IntSource

Length of the mutable vector.

null :: Storable a => MVector s a -> BoolSource

Check whether the vector is empty

Extracting subvectors

slice :: Storable a => Int -> Int -> MVector s a -> MVector s aSource

Yield a part of the mutable vector without copying it.

init :: Storable a => MVector s a -> MVector s aSource

tail :: Storable a => MVector s a -> MVector s aSource

take :: Storable a => Int -> MVector s a -> MVector s aSource

drop :: Storable a => Int -> MVector s a -> MVector s aSource

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

unsafeSliceSource

Arguments

:: Storable a 
=> Int

starting index

-> Int

length of the slice

-> MVector s a 
-> MVector s a 

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

unsafeTake :: Storable a => Int -> MVector s a -> MVector s aSource

unsafeDrop :: Storable a => Int -> MVector s a -> MVector s aSource

Overlapping

overlaps :: Storable a => MVector s a -> MVector s a -> BoolSource

Construction

Initialisation

new :: (PrimMonad m, Storable a) => Int -> m (MVector (PrimState m) a)Source

Create a mutable vector of the given length.

unsafeNew :: (PrimMonad m, Storable a) => Int -> m (MVector (PrimState m) a)Source

Create a mutable vector of the given length. The length is not checked.

replicate :: (PrimMonad m, Storable a) => 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, Storable a) => 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.

clone :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> m (MVector (PrimState m) a)Source

Create a copy of a mutable vector.

Growing

grow :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m (MVector (PrimState m) a)Source

Grow a vector by the given number of elements. The number must be positive.

unsafeGrow :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m (MVector (PrimState m) a)Source

Grow a vector by the given number of elements. The number must be positive but this is not checked.

Restricting memory usage

clear :: (PrimMonad m, Storable a) => MVector (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, Storable a) => MVector (PrimState m) a -> Int -> m aSource

Yield the element at the given position.

write :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> a -> m ()Source

Replace the element at the given position.

swap :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> Int -> m ()Source

Swap the elements at the given positions.

unsafeRead :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> m aSource

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

unsafeWrite :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> a -> m ()Source

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

unsafeSwap :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> Int -> Int -> m ()Source

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

Modifying vectors

Filling and copying

set :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> a -> m ()Source

Set all elements of the vector to the given value.

copy :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> MVector (PrimState m) a -> m ()Source

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

move :: (PrimMonad m, Storable a) => MVector (PrimState m) a -> MVector (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.

unsafeCopySource

Arguments

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

target

-> MVector (PrimState m) a

source

-> m () 

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

unsafeMoveSource

Arguments

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

target

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

Unsafe conversions

unsafeCast :: forall a b s. (Storable a, Storable b) => MVector s a -> MVector s bSource

O(1) Unsafely cast a mutable vector from one element type to another. The operation just changes the type of the underlying pointer and does not modify the elements.

The resulting vector contains as many elements as can fit into the underlying memory block.

Raw pointers

unsafeFromForeignPtrSource

Arguments

:: Storable a 
=> ForeignPtr a

pointer

-> Int

offset

-> Int

length

-> MVector s a 

Create a mutable vector from a ForeignPtr with an offset and a length.

Modifying data through the ForeignPtr afterwards is unsafe if the vector could have been frozen before the modification.

If your offset is 0 it is more efficient to use unsafeFromForeignPtr0.

unsafeFromForeignPtr0Source

Arguments

:: Storable a 
=> ForeignPtr a

pointer

-> Int

length

-> MVector s a 

O(1) Create a mutable vector from a ForeignPtr and a length.

It is assumed the pointer points directly to the data (no offset). Use unsafeFromForeignPtr if you need to specify an offset.

Modifying data through the ForeignPtr afterwards is unsafe if the vector could have been frozen before the modification.

unsafeToForeignPtr :: Storable a => MVector s a -> (ForeignPtr a, Int, Int)Source

Yield the underlying ForeignPtr together with the offset to the data and its length. Modifying the data through the ForeignPtr is unsafe if the vector could have frozen before the modification.

unsafeToForeignPtr0 :: Storable a => MVector s a -> (ForeignPtr a, Int)Source

O(1) Yield the underlying ForeignPtr together with its length.

You can assume the pointer points directly to the data (no offset).

Modifying the data through the ForeignPtr is unsafe if the vector could have frozen before the modification.

unsafeWith :: Storable a => IOVector a -> (Ptr a -> IO b) -> IO bSource

Pass a pointer to the vector's data to the IO action. Modifying data through the pointer is unsafe if the vector could have been frozen before the modification.