vector-0.10.0.1: Efficient Arrays

Portability | non-portable
Stability | experimental
Maintainer | Roman Leshchinskiy <rl@cse.unsw.edu.au>
Safe Haskell | None

Data.Vector.Generic.Mutable

Contents

- Class of mutable vector types
- Accessors
  - Length information
  - Extracting subvectors
  - Overlapping
- Construction
  - Initialisation
  - Growing
  - Restricting memory usage
- Accessing individual elements
- Modifying vectors
  - Filling and copying
- Internal operations

Description

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 :: PrimMonad m => Int -> m (v (PrimState m) a)
  - basicUnsafeReplicate :: PrimMonad m => Int -> a -> m (v (PrimState m) a)
  - basicUnsafeRead :: PrimMonad m => v (PrimState m) a -> Int -> m a
  - basicUnsafeWrite :: PrimMonad m => v (PrimState m) a -> Int -> a -> m ()
  - basicClear :: PrimMonad m => v (PrimState m) a -> m ()
  - basicSet :: PrimMonad m => v (PrimState m) a -> a -> m ()
  - basicUnsafeCopy :: PrimMonad m => v (PrimState m) a -> v (PrimState m) a -> m ()
  - basicUnsafeMove :: PrimMonad m => v (PrimState m) a -> v (PrimState m) a -> m ()
  - basicUnsafeGrow :: PrimMonad m => v (PrimState m) a -> Int -> m (v (PrimState m) a)
- length :: MVector v a => v s a -> Int
- null :: MVector v a => v s a -> Bool
- slice :: 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 :: (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)
- clone :: (PrimMonad m, MVector v a) => v (PrimState m) a -> m (v (PrimState m) a)
- grow :: (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)
- clear :: (PrimMonad m, MVector v a) => v (PrimState m) a -> m ()
- read :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> m a
- write :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> a -> m ()
- swap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m ()
- 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 ()
- unsafeSwap :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Int -> Int -> m ()
- set :: (PrimMonad m, MVector v a) => v (PrimState m) a -> a -> m ()
- copy :: (PrimMonad m, MVector v a) => v (PrimState m) a -> v (PrimState m) a -> m ()
- move :: (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 -> MStream m a
- mstreamR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a
- unstream :: (PrimMonad m, MVector v a) => Stream a -> m (v (PrimState m) a)
- unstreamR :: (PrimMonad m, MVector v a) => Stream a -> m (v (PrimState m) a)
- munstream :: (PrimMonad m, MVector v a) => MStream m a -> m (v (PrimState m) a)
- munstreamR :: (PrimMonad m, MVector v a) => MStream m a -> m (v (PrimState m) a)
- transform :: (PrimMonad m, MVector v a) => (MStream m a -> MStream m a) -> v (PrimState m) a -> m (v (PrimState m) a)
- transformR :: (PrimMonad m, MVector v a) => (MStream m a -> MStream m a) -> v (PrimState m) a -> m (v (PrimState m) a)
- fill :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a -> m (v (PrimState m) a)
- fillR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m a -> m (v (PrimState m) a)
- unsafeAccum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Stream (Int, b) -> m ()
- accum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Stream (Int, b) -> m ()
- unsafeUpdate :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream (Int, a) -> m ()
- update :: (PrimMonad m, MVector v a) => v (PrimState m) a -> Stream (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
- unstablePartitionStream :: (PrimMonad m, MVector v a) => (a -> Bool) -> Stream a -> m (v (PrimState m) a, v (PrimState m) a)
- partitionStream :: (PrimMonad m, MVector v a) => (a -> Bool) -> Stream a -> m (v (PrimState m) a, v (PrimState m) a)

# Class of mutable vector types

class MVector v a where Source

Class of mutable vectors parametrised with a primitive state token.

Minimum complete implementation:

- `basicLength`
- `basicUnsafeSlice`
- `basicOverlaps`
- `basicUnsafeNew`
- `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

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.

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 aSource

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 |
Storable a => MVector MVector a |
MVector MVector Bool |
MVector MVector Char |
MVector MVector Double |
MVector MVector Float |
MVector MVector Int |
MVector MVector Int8 |
MVector MVector Int16 |
MVector MVector Int32 |
MVector MVector Int64 |
MVector MVector Word |
MVector MVector Word8 |
MVector MVector Word16 |
MVector MVector Word32 |
MVector MVector Word64 |
MVector MVector () |
MVector MVector a |
(RealFloat a, Unbox a) => MVector MVector (Complex a) |
(Unbox a, Unbox b) => MVector MVector (a, b) |
(Unbox a, Unbox b, Unbox c) => MVector MVector (a, b, c) |
(Unbox a, Unbox b, Unbox c, Unbox d) => MVector MVector (a, b, c, d) |
(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => MVector MVector (a, b, c, d, e) |
(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => MVector MVector (a, b, c, d, e, f) |

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

Yield a part of the mutable vector without copying it.

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

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

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

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

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 aSource

unsafeTail :: MVector v a => v s a -> v s aSource

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

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

## Overlapping

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

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

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

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.

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

Swap the elements at the given positions.

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

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.

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.

# 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 -> MStream m aSource

mstreamR :: (PrimMonad m, MVector v a) => v (PrimState m) a -> MStream m aSource

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

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

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

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

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

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

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

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

unsafeAccum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Stream (Int, b) -> m ()Source

accum :: (PrimMonad m, MVector v a) => (a -> b -> a) -> v (PrimState m) a -> Stream (Int, b) -> m ()Source

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

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

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

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