Z.Data.Array.UnliftedArray

GHC contains three general classes of value types:

1. Unboxed types: values are machine values made up of fixed numbers of bytes
2. Unlifted types: values are pointers, but strictly evaluated
3. Lifted types: values are pointers, lazily evaluated

The first category can be stored in a ByteArray, and this allows types in category 3 that are simple wrappers around category 1 types to be stored more efficiently using a ByteArray. This module provides the same facility for category 2 types.

GHC has two primitive types, ArrayArray# and MutableArrayArray#. These are arrays of pointers, but of category 2 values, so they are known to not be bottom. This allows types that are wrappers around such types to be stored in an array without an extra level of indirection.

The way that the ArrayArray# API works is that one can read and write ArrayArray# values to the positions. This works because all category 2 types share a uniform representation, unlike unboxed values which are represented by varying (by type) numbers of bytes. However, using the this makes the internal API very unsafe to use, as one has to coerce values to and from ArrayArray#.

The API presented by this module is more type safe. UnliftedArray and MutableUnliftedArray are parameterized by the type of arrays they contain, and the coercions necessary are abstracted into a class, PrimUnlifted, of things that are eligible to be stored.

Documentation

class PrimUnlifted a where

Types with TYPE UnliftedRep, which can be stored / retrieved in ArrayArray#.

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (# State# s, a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> a

Instances

PrimUnlifted ByteArray

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> ByteArray -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (# State# s, ByteArray #)

indexUnliftedArray# :: ArrayArray# -> Int# -> ByteArray

PrimUnlifted (TVar a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> TVar a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (# State# s, TVar a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> TVar a

PrimUnlifted (IORef a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> IORef a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (# State# s, IORef a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> IORef a

PrimUnlifted (MVar a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> MVar a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (# State# s, MVar a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> MVar a

PrimUnlifted (PrimArray a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s -> Int# -> PrimArray a -> State# s -> State# s

readUnliftedArray# :: MutableArrayArray# s -> Int# -> State# s -> (# State# s, PrimArray a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> PrimArray a

PrimUnlifted (MutableByteArray s)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> MutableByteArray s -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (# State# s0, MutableByteArray s #)

indexUnliftedArray# :: ArrayArray# -> Int# -> MutableByteArray s

PrimUnlifted (STRef s a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> STRef s a -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (# State# s0, STRef s a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> STRef s a

PrimUnlifted (MutablePrimArray s a)

Defined in Z.Data.Array.UnliftedArray

Methods

writeUnliftedArray# :: MutableArrayArray# s0 -> Int# -> MutablePrimArray s a -> State# s0 -> State# s0

readUnliftedArray# :: MutableArrayArray# s0 -> Int# -> State# s0 -> (# State# s0, MutablePrimArray s a #)

indexUnliftedArray# :: ArrayArray# -> Int# -> MutablePrimArray s a

data MutableUnliftedArray s a

Mutable array holding PrimUnlifted values.

Constructors

MutableUnliftedArray (MutableArrayArray# s)

data UnliftedArray a

Array holding PrimUnlifted values.

Constructors

UnliftedArray ArrayArray#

Instances

PrimUnlifted a => Arr (UnliftedArray :: Type -> Type) a

Defined in Z.Data.Array

Associated Types

type MArr UnliftedArray = (mar :: Type -> Type -> Type)

Methods

newArr :: (PrimMonad m, PrimState m ~ s) => Int -> m (MArr UnliftedArray s a)

newArrWith :: (PrimMonad m, PrimState m ~ s) => Int -> a -> m (MArr UnliftedArray s a)

readArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m a

writeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> a -> m ()

setArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> a -> m ()

indexArr :: UnliftedArray a -> Int -> a

indexArr' :: UnliftedArray a -> Int -> (# a #)

indexArrM :: Monad m => UnliftedArray a -> Int -> m a

freezeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> m (UnliftedArray a)

thawArr :: (PrimMonad m, PrimState m ~ s) => UnliftedArray a -> Int -> Int -> m (MArr UnliftedArray s a)

unsafeFreezeArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> m (UnliftedArray a)

unsafeThawArr :: (PrimMonad m, PrimState m ~ s) => UnliftedArray a -> m (MArr UnliftedArray s a)

copyArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> UnliftedArray a -> Int -> Int -> m ()

copyMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> MArr UnliftedArray s a -> Int -> Int -> m ()

moveArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> MArr UnliftedArray s a -> Int -> Int -> m ()

cloneArr :: UnliftedArray a -> Int -> Int -> UnliftedArray a

cloneMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> Int -> m (MArr UnliftedArray s a)

resizeMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m (MArr UnliftedArray s a)

shrinkMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> Int -> m ()

sameMutableArr :: MArr UnliftedArray s a -> MArr UnliftedArray s a -> Bool

sizeofArr :: UnliftedArray a -> Int

sizeofMutableArr :: (PrimMonad m, PrimState m ~ s) => MArr UnliftedArray s a -> m Int

sameArr :: UnliftedArray a -> UnliftedArray a -> Bool

PrimUnlifted a => Vec (UnliftedArray :: Type -> Type) a

Defined in Z.Data.Vector.Base

Associated Types

type IArray UnliftedArray :: Type -> Type

Methods

toArr :: UnliftedArray a -> (IArray UnliftedArray a, Int, Int)

fromArr :: IArray UnliftedArray a -> Int -> Int -> UnliftedArray a

(PrimUnlifted a, Print a) => Print (UnliftedArray a)

Defined in Z.Data.Text.Print

Methods

toUTF8BuilderP :: Int -> UnliftedArray a -> Builder ()

(PrimUnlifted a, JSON a) => JSON (UnliftedArray a)

Defined in Z.Data.JSON.Base

Methods

fromValue :: Value -> Converter (UnliftedArray a)

toValue :: UnliftedArray a -> Value

encodeJSON :: UnliftedArray a -> Builder ()

type MArr (UnliftedArray :: Type -> Type)

Defined in Z.Data.Array

type MArr (UnliftedArray :: Type -> Type) = MutableUnliftedArray :: Type -> Type -> Type

type IArray (UnliftedArray :: Type -> Type)

Defined in Z.Data.Vector.Base

type IArray (UnliftedArray :: Type -> Type) = UnliftedArray :: Type -> Type

unsafeNewUnliftedArray

Arguments

:: PrimMonad m

=> Int

size

-> m (MutableUnliftedArray (PrimState m) a)

Creates a new MutableUnliftedArray. This function is unsafe because it initializes all elements of the array as pointers to the array itself. Attempting to read one of these elements before writing to it is in effect an unsafe coercion from the MutableUnliftedArray s a to the element type.

newUnliftedArray

Arguments

:: (PrimMonad m, PrimUnlifted a)

=> Int

size

-> a

initial value

-> m (MutableUnliftedArray (PrimState m) a)

Creates a new MutableUnliftedArray with the specified value as initial contents. This is slower than unsafeNewUnliftedArray, but safer.

setUnliftedArray

Arguments

:: (PrimMonad m, PrimUnlifted a)

=> MutableUnliftedArray (PrimState m) a

destination

-> Int

offset

-> Int

length

-> a

value to fill with

-> m ()

sizeofUnliftedArray :: UnliftedArray e -> Int

Yields the length of an UnliftedArray.

sizeofMutableUnliftedArray :: MutableUnliftedArray s e -> Int

Yields the length of a MutableUnliftedArray.

writeUnliftedArray :: (PrimMonad m, PrimUnlifted a) => MutableUnliftedArray (PrimState m) a -> Int -> a -> m ()

readUnliftedArray :: (PrimMonad m, PrimUnlifted a) => MutableUnliftedArray (PrimState m) a -> Int -> m a

indexUnliftedArray :: PrimUnlifted a => UnliftedArray a -> Int -> a

unsafeFreezeUnliftedArray :: PrimMonad m => MutableUnliftedArray (PrimState m) a -> m (UnliftedArray a)

Freezes a MutableUnliftedArray, yielding an UnliftedArray. This simply marks the array as frozen in place, so it should only be used when no further modifications to the mutable array will be performed.

sameMutableUnliftedArray :: MutableUnliftedArray s a -> MutableUnliftedArray s a -> Bool

Determines whether two MutableUnliftedArray values are the same. This is object/pointer identity, not based on the contents.

copyUnliftedArray

Arguments

:: PrimMonad m

=> MutableUnliftedArray (PrimState m) a

destination

-> Int

offset into destination

-> UnliftedArray a

source

-> Int

offset into source

-> Int

number of elements to copy

-> m ()

Copies the contents of an immutable array into a mutable array.

copyMutableUnliftedArray

Arguments

:: PrimMonad m

=> MutableUnliftedArray (PrimState m) a

destination

-> Int

offset into destination

-> MutableUnliftedArray (PrimState m) a

source

-> Int

offset into source

-> Int

number of elements to copy

-> m ()

Copies the contents of one mutable array into another.

freezeUnliftedArray

Arguments

:: PrimMonad m

=> MutableUnliftedArray (PrimState m) a

source

-> Int

offset

-> Int

length

-> m (UnliftedArray a)

Freezes a portion of a MutableUnliftedArray, yielding an UnliftedArray. This operation is safe, in that it copies the frozen portion, and the existing mutable array may still be used afterward.

thawUnliftedArray

Arguments

:: PrimMonad m

=> UnliftedArray a

source

-> Int

offset

-> Int

length

-> m (MutableUnliftedArray (PrimState m) a)

Thaws a portion of an UnliftedArray, yielding a MutableUnliftedArray. This copies the thawed portion, so mutations will not affect the original array.

cloneUnliftedArray

Arguments

:: UnliftedArray a

source

-> Int

offset

-> Int

length

-> UnliftedArray a

Creates a copy of a portion of an UnliftedArray

cloneMutableUnliftedArray

Arguments

:: PrimMonad m

=> MutableUnliftedArray (PrimState m) a

source

-> Int

offset

-> Int

length

-> m (MutableUnliftedArray (PrimState m) a)

Creates a new MutableUnliftedArray containing a copy of a portion of another mutable array.