Cgm.Data.Array

Documentation

type ArrayIx a = Len (ArrayElem a) Word

class Array a where

Associated Types

type ArrayElem a :: *

Methods

arrayLen :: a -> ArrayIx a

Instances

Array a => Array (ArrayRange a)

Prim w => Array (PrimArray f w)

Prim w => Array (STPrimArray s f w)

class Array a => ImmArray a where

Methods

indexArray :: a -> ArrayIx a -> ArrayElem a

Instances

(Array (ArrayRange a), ImmArray a) => ImmArray (ArrayRange a)

(Array (PrimArray f w), Prim w) => ImmArray (PrimArray f w)

class Array a => STArray a

Associated Types

type ArrayState a :: *

Instances

(Array (ArrayRange a), STArray a) => STArray (ArrayRange a)

(Array (STPrimArray s f w), Prim w) => STArray (STPrimArray s f w)

class STArray a => STMkArray a where

STArrays that are instantiable in GCed memory

Methods

mkArray :: ArrayIx a -> ArrayST a a

Instances

(STArray (STPrimArray s f w), Allocation f, Prim w) => STMkArray (STPrimArray s f w)

class STArray a => STZArray a where

STArrays that can be mutated using zero based indexing

Methods

readArray :: a -> ArrayIx a -> ArrayST a (ArrayElem a)

writeArray :: a -> ArrayIx a -> ArrayElem a -> ArrayST a ()

Instances

(STArray (ArrayRange a), STZArray a) => STZArray (ArrayRange a)

(STArray (STPrimArray s f w), Prim w) => STZArray (STPrimArray s f w)

class Array a => PinnedArray a where

Methods

withArrayPtr :: (Ptr (ArrayElem a) -> ArrayIx a -> IO b) -> a -> IO b

Instances

(Array (ArrayRange a), Prim (ArrayElem a), PinnedArray a) => PinnedArray (ArrayRange a)

(Array (PrimArray Pinned w), Prim w) => PinnedArray (PrimArray Pinned w)

(Array (STPrimArray s Pinned w), Prim w) => PinnedArray (STPrimArray s Pinned w)

class Allocation f where

Methods

newWord8Array :: Len Word8 Word -> ST s (STPrimArray s f Word8)

onAllocation :: (f ~ Free => z) -> (f ~ Pinned => z) -> Tagged f z

Instances

Allocation Pinned

Allocation Free

newAlignedPinnedWord8Array :: Len Word8 Word -> Len Word8 Word -> ST s (STPrimArray s f Word8)

withArrayByteString :: (PinnedArray a, ArrayElem a ~ Word8) => (ByteString -> IO b) -> a -> IO b

arrayFromByteString :: Allocation f => ByteString -> PrimArray f Word8

unsafeWithCastArrayByteString :: forall a b. (PinnedArray a, Prim (ArrayElem a)) => (ByteString -> IO b) -> a -> IO b

data Free

Instances

Allocation Free

data Pinned

Instances

Allocation Pinned

(Array (PrimArray Pinned w), Prim w) => PinnedArray (PrimArray Pinned w)

(Array (STPrimArray s Pinned w), Prim w) => PinnedArray (STPrimArray s Pinned w)

primArrayMatchAllocation :: forall f f' w. (Allocation f, Allocation f', Prim w) => ArrayRange (PrimArray f w) -> ArrayRange (PrimArray f' w)

data PrimArray f w

f is either Free or Pinned

Instances

WordConv1 (PrimArray f)

(Prim w, Eq w) => Eq (PrimArray f w)

(Prim w, Show w) => Show (PrimArray f w)

(Array (PrimArray Pinned w), Prim w) => PinnedArray (PrimArray Pinned w)

(Array (PrimArray f w), Prim w) => ImmArray (PrimArray f w)

Prim w => Array (PrimArray f w)

runSTPrimArray :: (forall s. ST s (STPrimArray s f w)) -> PrimArray f w

unsafeFreezeSTPrimArray :: STPrimArray s f w -> ST s (PrimArray f w)

Safe as long as the input array is not written to after this call. Use the safe runSTPrimArray when possible.

data STPrimArray s f w

f is either Free or Pinned

Instances

WordConv1 (STPrimArray s f)

Eq (STPrimArray s f w)

(Array (STPrimArray s Pinned w), Prim w) => PinnedArray (STPrimArray s Pinned w)

(STArray (STPrimArray s f w), Prim w) => STZArray (STPrimArray s f w)

(STArray (STPrimArray s f w), Allocation f, Prim w) => STMkArray (STPrimArray s f w)

(Array (STPrimArray s f w), Prim w) => STArray (STPrimArray s f w)

Prim w => Array (STPrimArray s f w)

data ArrayRange a

Constructors

ArrayRange a (ArrayIx a) (ArrayIx a)

Instances

(ImmArray a, Eq (ArrayElem a), Prim (ArrayElem a)) => Eq (ArrayRange a)

(ImmArray a, Show (ArrayElem a)) => Show (ArrayRange a)

(Array (ArrayRange a), Prim (ArrayElem a), PinnedArray a) => PinnedArray (ArrayRange a)

(STArray (ArrayRange a), STZArray a) => STZArray (ArrayRange a)

(Array (ArrayRange a), STArray a) => STArray (ArrayRange a)

(Array (ArrayRange a), ImmArray a) => ImmArray (ArrayRange a)

Array a => Array (ArrayRange a)

fullArrayRange :: Array a => a -> ArrayRange a

skipArrayRange :: Array a => ArrayIx a -> ArrayRange a -> ArrayRange a

headArrayRange :: Array a => ArrayIx a -> ArrayRange a -> ArrayRange a

wordConvArrayRange :: WordConv c => Bijection' (ArrayRange (PrimArray f Word)) (ArrayRange (PrimArray f c))

unsafePrimArrayCast :: PrimArray f w -> PrimArray f w'

unsafeSTPrimArrayCast :: STPrimArray s f w -> STPrimArray s f w'

mapMArray :: STZArray a => (ArrayElem a -> ArrayST a (ArrayElem a)) -> a -> ArrayST a ()

mapMArrayCopy :: (STZArray a, STZArray b, ArrayState a ~ ArrayState b) => (ArrayElem a -> ArrayST a (ArrayElem b)) -> a -> b -> ArrayST a ()

The number of elements copied is the minimum of the number of elements in the source and the number of elements in the destination

mapMArrayCopyImm :: (ImmArray a, STZArray b) => (ArrayElem a -> ArrayST b (ArrayElem b)) -> a -> b -> ArrayST b ()

The number of elements copied is the minimum of the number of elements in the source and the number of elements in the destination

mapImmArray :: (Allocation f', Prim b, ImmArray r) => (ArrayElem r -> b) -> r -> PrimArray f' b

mkArrayWith :: (Allocation f, Prim a) => Len a Word -> (Len a Word -> a) -> PrimArray f a

ioToST :: IO a -> ST RealWorld a

primSizeOf :: Prim w => w -> Int

newtype ST s a

The strict state-transformer monad. A computation of type ST s a transforms an internal state indexed by s, and returns a value of type a. The s parameter is either

• an uninstantiated type variable (inside invocations of runST), or
• RealWorld (inside invocations of stToIO).

It serves to keep the internal states of different invocations of runST separate from each other and from invocations of stToIO.

The >>= and >> operations are strict in the state (though not in values stored in the state). For example,

runST (writeSTRef _|_ v >>= f) = _|_

Constructors

ST (STRep s a)

Instances

Typeable2 ST

Monad (ST s)

Functor (ST s)

Functor (ST s) => Applicative (ST s)

Monad (ST s) => PrimMonad (ST s)

Show (ST s a)

module Control.Monad.ST

module Data.Primitive.Types