Data.Massiv.Array.Mutable

Documentation

class Manifest r ix e => Mutable r ix e where

Minimal complete definition

msize, unsafeThaw, unsafeFreeze, unsafeNew, unsafeNewZero, unsafeLinearRead, unsafeLinearWrite

Associated Types

data MArray s r ix e :: *

Methods

msize :: MArray s r ix e -> ix

Get the size of a mutable array.

Instances

(Unbox e, Index ix) => Mutable U ix e

Associated Types

data MArray s U ix e :: *

Methods

msize :: MArray s U ix e -> ix

unsafeThaw :: PrimMonad m => Array U ix e -> m (MArray (PrimState m) U ix e)

unsafeFreeze :: PrimMonad m => Comp -> MArray (PrimState m) U ix e -> m (Array U ix e)

unsafeNew :: PrimMonad m => ix -> m (MArray (PrimState m) U ix e)

unsafeNewZero :: PrimMonad m => ix -> m (MArray (PrimState m) U ix e)

unsafeLinearRead :: PrimMonad m => MArray (PrimState m) U ix e -> Int -> m e

unsafeLinearWrite :: PrimMonad m => MArray (PrimState m) U ix e -> Int -> e -> m ()

(Index ix, Storable e) => Mutable S ix e

Associated Types

data MArray s S ix e :: *

Methods

msize :: MArray s S ix e -> ix

unsafeThaw :: PrimMonad m => Array S ix e -> m (MArray (PrimState m) S ix e)

unsafeFreeze :: PrimMonad m => Comp -> MArray (PrimState m) S ix e -> m (Array S ix e)

unsafeNew :: PrimMonad m => ix -> m (MArray (PrimState m) S ix e)

unsafeNewZero :: PrimMonad m => ix -> m (MArray (PrimState m) S ix e)

unsafeLinearRead :: PrimMonad m => MArray (PrimState m) S ix e -> Int -> m e

unsafeLinearWrite :: PrimMonad m => MArray (PrimState m) S ix e -> Int -> e -> m ()

(Index ix, Prim e) => Mutable P ix e

Associated Types

data MArray s P ix e :: *

Methods

msize :: MArray s P ix e -> ix

unsafeThaw :: PrimMonad m => Array P ix e -> m (MArray (PrimState m) P ix e)

unsafeFreeze :: PrimMonad m => Comp -> MArray (PrimState m) P ix e -> m (Array P ix e)

unsafeNew :: PrimMonad m => ix -> m (MArray (PrimState m) P ix e)

unsafeNewZero :: PrimMonad m => ix -> m (MArray (PrimState m) P ix e)

unsafeLinearRead :: PrimMonad m => MArray (PrimState m) P ix e -> Int -> m e

unsafeLinearWrite :: PrimMonad m => MArray (PrimState m) P ix e -> Int -> e -> m ()

(Index ix, NFData e) => Mutable N ix e

Associated Types

data MArray s N ix e :: *

Methods

msize :: MArray s N ix e -> ix

unsafeThaw :: PrimMonad m => Array N ix e -> m (MArray (PrimState m) N ix e)

unsafeFreeze :: PrimMonad m => Comp -> MArray (PrimState m) N ix e -> m (Array N ix e)

unsafeNew :: PrimMonad m => ix -> m (MArray (PrimState m) N ix e)

unsafeNewZero :: PrimMonad m => ix -> m (MArray (PrimState m) N ix e)

unsafeLinearRead :: PrimMonad m => MArray (PrimState m) N ix e -> Int -> m e

unsafeLinearWrite :: PrimMonad m => MArray (PrimState m) N ix e -> Int -> e -> m ()

Index ix => Mutable B ix e

Associated Types

data MArray s B ix e :: *

Methods

msize :: MArray s B ix e -> ix

unsafeThaw :: PrimMonad m => Array B ix e -> m (MArray (PrimState m) B ix e)

unsafeFreeze :: PrimMonad m => Comp -> MArray (PrimState m) B ix e -> m (Array B ix e)

unsafeNew :: PrimMonad m => ix -> m (MArray (PrimState m) B ix e)

unsafeNewZero :: PrimMonad m => ix -> m (MArray (PrimState m) B ix e)

unsafeLinearRead :: PrimMonad m => MArray (PrimState m) B ix e -> Int -> m e

unsafeLinearWrite :: PrimMonad m => MArray (PrimState m) B ix e -> Int -> e -> m ()

msize :: Mutable r ix e => MArray s r ix e -> ix

Get the size of a mutable array.

new :: (Mutable r ix e, PrimMonad m) => ix -> m (MArray (PrimState m) r ix e)

Initialize a new mutable array. Negative size will result in an empty array.

thaw :: (Mutable r ix e, PrimMonad m) => Array r ix e -> m (MArray (PrimState m) r ix e)

O(n) - Yield a mutable copy of the immutable array

freeze :: (Mutable r ix e, PrimMonad m) => Comp -> MArray (PrimState m) r ix e -> m (Array r ix e)

O(n) - Yield an immutable copy of the mutable array

read :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> ix -> m (Maybe e)

O(1) - Lookup an element in the mutable array. Return Nothing when index is out of bounds.

read' :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> ix -> m e

O(1) - Same as read, but throws an error if index is out of bounds.

write :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> ix -> e -> m Bool

O(1) - Write an element into the cell of a mutable array. Returns False when index is out of bounds.

write' :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> ix -> e -> m ()

O(1) - Same as write, but throws an error if index is out of bounds.

modify :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> (e -> e) -> ix -> m Bool

O(1) - Modify an element in the cell of a mutable array with a supplied function. Returns False when index is out of bounds.

modify' :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> (e -> e) -> ix -> m ()

O(1) - Same as modify, but throws an error if index is out of bounds.

swap :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> ix -> ix -> m Bool

O(1) - Swap two elements in a mutable array by supplying their indices. Returns False when either one of the indices is out of bounds.

swap' :: (Mutable r ix e, PrimMonad m) => MArray (PrimState m) r ix e -> ix -> ix -> m ()

O(1) - Same as swap, but throws an error if index is out of bounds.