Basement.UArray

An unboxed array of primitive types

All the cells in the array are in one chunk of contiguous memory.

Documentation

data UArray ty

An array of type built on top of GHC primitive.

The elements need to have fixed sized and the representation is a packed contiguous array in memory that can easily be passed to foreign interface

Constructors

UArray !(Offset ty) !(CountOf ty) !(UArrayBackend ty)

Instances

From AsciiString (UArray Word8)

Methods

from :: AsciiString -> UArray Word8

From String (UArray Word8)

Methods

from :: String -> UArray Word8

PrimType ty => IsList (UArray ty)

Associated Types

type Item (UArray ty) :: *

Methods

fromList :: [Item (UArray ty)] -> UArray ty

fromListN :: Int -> [Item (UArray ty)] -> UArray ty

toList :: UArray ty -> [Item (UArray ty)]

(PrimType ty, Eq ty) => Eq (UArray ty)

Methods

(==) :: UArray ty -> UArray ty -> Bool

(/=) :: UArray ty -> UArray ty -> Bool

Data ty => Data (UArray ty)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UArray ty -> c (UArray ty)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (UArray ty)

toConstr :: UArray ty -> Constr

dataTypeOf :: UArray ty -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (UArray ty))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (UArray ty))

gmapT :: (forall b. Data b => b -> b) -> UArray ty -> UArray ty

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UArray ty -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UArray ty -> r

gmapQ :: (forall d. Data d => d -> u) -> UArray ty -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UArray ty -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UArray ty -> m (UArray ty)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UArray ty -> m (UArray ty)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UArray ty -> m (UArray ty)

(PrimType ty, Ord ty) => Ord (UArray ty)

Methods

compare :: UArray ty -> UArray ty -> Ordering

(<) :: UArray ty -> UArray ty -> Bool

(<=) :: UArray ty -> UArray ty -> Bool

(>) :: UArray ty -> UArray ty -> Bool

(>=) :: UArray ty -> UArray ty -> Bool

max :: UArray ty -> UArray ty -> UArray ty

min :: UArray ty -> UArray ty -> UArray ty

(PrimType ty, Show ty) => Show (UArray ty)

Methods

showsPrec :: Int -> UArray ty -> ShowS

show :: UArray ty -> String

showList :: [UArray ty] -> ShowS

PrimType ty => Semigroup (UArray ty)

Methods

(<>) :: UArray ty -> UArray ty -> UArray ty

sconcat :: NonEmpty (UArray ty) -> UArray ty

stimes :: Integral b => b -> UArray ty -> UArray ty

PrimType ty => Monoid (UArray ty)

Methods

mempty :: UArray ty

mappend :: UArray ty -> UArray ty -> UArray ty

mconcat :: [UArray ty] -> UArray ty

NormalForm (UArray ty)

Methods

toNormalForm :: UArray ty -> ()

TryFrom (UArray Word8) String

Methods

tryFrom :: UArray Word8 -> Maybe String

PrimType ty => From (Block ty) (UArray ty)

Methods

from :: Block ty -> UArray ty

PrimType ty => From (UArray ty) (Array ty)

Methods

from :: UArray ty -> Array ty

PrimType ty => From (UArray ty) (Block ty)

Methods

from :: UArray ty -> Block ty

PrimType ty => From (Array ty) (UArray ty)

Methods

from :: Array ty -> UArray ty

(NatWithinBound (CountOf ty) n, KnownNat n, PrimType ty) => TryFrom (UArray ty) (BlockN n ty)

Methods

tryFrom :: UArray ty -> Maybe (BlockN n ty)

(NatWithinBound Int n, PrimType ty) => From (BlockN n ty) (UArray ty)

Methods

from :: BlockN n ty -> UArray ty

type Item (UArray ty)

type Item (UArray ty) = ty

class Eq ty => PrimType ty where

Represent the accessor for types that can be stored in the UArray and MUArray.

Types need to be a instance of storable and have fixed sized.

Minimal complete definition

primSizeInBytes, primShiftToBytes, primBaUIndex, primMbaURead, primMbaUWrite, primAddrIndex, primAddrRead, primAddrWrite

Associated Types

type PrimSize ty :: Nat

type level size of the given ty

Methods

primSizeInBytes :: Proxy ty -> CountOf Word8

get the size in bytes of a ty element

primShiftToBytes :: Proxy ty -> Int

get the shift size

primBaUIndex :: ByteArray# -> Offset ty -> ty

return the element stored at a specific index

primMbaURead

Arguments

:: PrimMonad prim

=> MutableByteArray# (PrimState prim)

mutable array to read from

-> Offset ty

index of the element to retrieve

-> prim ty

the element returned

Read an element at an index in a mutable array

primMbaUWrite

Arguments

:: PrimMonad prim

=> MutableByteArray# (PrimState prim)

mutable array to modify

-> Offset ty

index of the element to modify

-> ty

the new value to store

-> prim ()

Write an element to a specific cell in a mutable array.

primAddrIndex :: Addr# -> Offset ty -> ty

Read from Address, without a state. the value read should be considered a constant for all pratical purpose, otherwise bad thing will happens.

primAddrRead :: PrimMonad prim => Addr# -> Offset ty -> prim ty

Read a value from Addr in a specific primitive monad

primAddrWrite :: PrimMonad prim => Addr# -> Offset ty -> ty -> prim ()

Write a value to Addr in a specific primitive monad

Instances

PrimType Char

Associated Types

type PrimSize Char :: Nat

Methods

primSizeInBytes :: Proxy * Char -> CountOf Word8

primShiftToBytes :: Proxy * Char -> Int

primBaUIndex :: ByteArray# -> Offset Char -> Char

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Char -> prim Char

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Char -> Char -> prim ()

primAddrIndex :: Addr# -> Offset Char -> Char

primAddrRead :: PrimMonad prim => Addr# -> Offset Char -> prim Char

primAddrWrite :: PrimMonad prim => Addr# -> Offset Char -> Char -> prim ()

PrimType Double

Associated Types

type PrimSize Double :: Nat

Methods

primSizeInBytes :: Proxy * Double -> CountOf Word8

primShiftToBytes :: Proxy * Double -> Int

primBaUIndex :: ByteArray# -> Offset Double -> Double

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Double -> prim Double

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Double -> Double -> prim ()

primAddrIndex :: Addr# -> Offset Double -> Double

primAddrRead :: PrimMonad prim => Addr# -> Offset Double -> prim Double

primAddrWrite :: PrimMonad prim => Addr# -> Offset Double -> Double -> prim ()

PrimType Float

Associated Types

type PrimSize Float :: Nat

Methods

primSizeInBytes :: Proxy * Float -> CountOf Word8

primShiftToBytes :: Proxy * Float -> Int

primBaUIndex :: ByteArray# -> Offset Float -> Float

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Float -> prim Float

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Float -> Float -> prim ()

primAddrIndex :: Addr# -> Offset Float -> Float

primAddrRead :: PrimMonad prim => Addr# -> Offset Float -> prim Float

primAddrWrite :: PrimMonad prim => Addr# -> Offset Float -> Float -> prim ()

PrimType Int

Associated Types

type PrimSize Int :: Nat

Methods

primSizeInBytes :: Proxy * Int -> CountOf Word8

primShiftToBytes :: Proxy * Int -> Int

primBaUIndex :: ByteArray# -> Offset Int -> Int

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int -> prim Int

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int -> Int -> prim ()

primAddrIndex :: Addr# -> Offset Int -> Int

primAddrRead :: PrimMonad prim => Addr# -> Offset Int -> prim Int

primAddrWrite :: PrimMonad prim => Addr# -> Offset Int -> Int -> prim ()

PrimType Int8

Associated Types

type PrimSize Int8 :: Nat

Methods

primSizeInBytes :: Proxy * Int8 -> CountOf Word8

primShiftToBytes :: Proxy * Int8 -> Int

primBaUIndex :: ByteArray# -> Offset Int8 -> Int8

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int8 -> prim Int8

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int8 -> Int8 -> prim ()

primAddrIndex :: Addr# -> Offset Int8 -> Int8

primAddrRead :: PrimMonad prim => Addr# -> Offset Int8 -> prim Int8

primAddrWrite :: PrimMonad prim => Addr# -> Offset Int8 -> Int8 -> prim ()

PrimType Int16

Associated Types

type PrimSize Int16 :: Nat

Methods

primSizeInBytes :: Proxy * Int16 -> CountOf Word8

primShiftToBytes :: Proxy * Int16 -> Int

primBaUIndex :: ByteArray# -> Offset Int16 -> Int16

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int16 -> prim Int16

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int16 -> Int16 -> prim ()

primAddrIndex :: Addr# -> Offset Int16 -> Int16

primAddrRead :: PrimMonad prim => Addr# -> Offset Int16 -> prim Int16

primAddrWrite :: PrimMonad prim => Addr# -> Offset Int16 -> Int16 -> prim ()

PrimType Int32

Associated Types

type PrimSize Int32 :: Nat

Methods

primSizeInBytes :: Proxy * Int32 -> CountOf Word8

primShiftToBytes :: Proxy * Int32 -> Int

primBaUIndex :: ByteArray# -> Offset Int32 -> Int32

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int32 -> prim Int32

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int32 -> Int32 -> prim ()

primAddrIndex :: Addr# -> Offset Int32 -> Int32

primAddrRead :: PrimMonad prim => Addr# -> Offset Int32 -> prim Int32

primAddrWrite :: PrimMonad prim => Addr# -> Offset Int32 -> Int32 -> prim ()

PrimType Int64

Associated Types

type PrimSize Int64 :: Nat

Methods

primSizeInBytes :: Proxy * Int64 -> CountOf Word8

primShiftToBytes :: Proxy * Int64 -> Int

primBaUIndex :: ByteArray# -> Offset Int64 -> Int64

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int64 -> prim Int64

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Int64 -> Int64 -> prim ()

primAddrIndex :: Addr# -> Offset Int64 -> Int64

primAddrRead :: PrimMonad prim => Addr# -> Offset Int64 -> prim Int64

primAddrWrite :: PrimMonad prim => Addr# -> Offset Int64 -> Int64 -> prim ()

PrimType Word

Associated Types

type PrimSize Word :: Nat

Methods

primSizeInBytes :: Proxy * Word -> CountOf Word8

primShiftToBytes :: Proxy * Word -> Int

primBaUIndex :: ByteArray# -> Offset Word -> Word

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word -> prim Word

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word -> Word -> prim ()

primAddrIndex :: Addr# -> Offset Word -> Word

primAddrRead :: PrimMonad prim => Addr# -> Offset Word -> prim Word

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word -> Word -> prim ()

PrimType Word8

Associated Types

type PrimSize Word8 :: Nat

Methods

primSizeInBytes :: Proxy * Word8 -> CountOf Word8

primShiftToBytes :: Proxy * Word8 -> Int

primBaUIndex :: ByteArray# -> Offset Word8 -> Word8

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word8 -> prim Word8

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word8 -> Word8 -> prim ()

primAddrIndex :: Addr# -> Offset Word8 -> Word8

primAddrRead :: PrimMonad prim => Addr# -> Offset Word8 -> prim Word8

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word8 -> Word8 -> prim ()

PrimType Word16

Associated Types

type PrimSize Word16 :: Nat

Methods

primSizeInBytes :: Proxy * Word16 -> CountOf Word8

primShiftToBytes :: Proxy * Word16 -> Int

primBaUIndex :: ByteArray# -> Offset Word16 -> Word16

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word16 -> prim Word16

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word16 -> Word16 -> prim ()

primAddrIndex :: Addr# -> Offset Word16 -> Word16

primAddrRead :: PrimMonad prim => Addr# -> Offset Word16 -> prim Word16

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word16 -> Word16 -> prim ()

PrimType Word32

Associated Types

type PrimSize Word32 :: Nat

Methods

primSizeInBytes :: Proxy * Word32 -> CountOf Word8

primShiftToBytes :: Proxy * Word32 -> Int

primBaUIndex :: ByteArray# -> Offset Word32 -> Word32

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word32 -> prim Word32

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word32 -> Word32 -> prim ()

primAddrIndex :: Addr# -> Offset Word32 -> Word32

primAddrRead :: PrimMonad prim => Addr# -> Offset Word32 -> prim Word32

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word32 -> Word32 -> prim ()

PrimType Word64

Associated Types

type PrimSize Word64 :: Nat

Methods

primSizeInBytes :: Proxy * Word64 -> CountOf Word8

primShiftToBytes :: Proxy * Word64 -> Int

primBaUIndex :: ByteArray# -> Offset Word64 -> Word64

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word64 -> prim Word64

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word64 -> Word64 -> prim ()

primAddrIndex :: Addr# -> Offset Word64 -> Word64

primAddrRead :: PrimMonad prim => Addr# -> Offset Word64 -> prim Word64

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word64 -> Word64 -> prim ()

PrimType CChar

Associated Types

type PrimSize CChar :: Nat

Methods

primSizeInBytes :: Proxy * CChar -> CountOf Word8

primShiftToBytes :: Proxy * CChar -> Int

primBaUIndex :: ByteArray# -> Offset CChar -> CChar

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset CChar -> prim CChar

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset CChar -> CChar -> prim ()

primAddrIndex :: Addr# -> Offset CChar -> CChar

primAddrRead :: PrimMonad prim => Addr# -> Offset CChar -> prim CChar

primAddrWrite :: PrimMonad prim => Addr# -> Offset CChar -> CChar -> prim ()

PrimType CUChar

Associated Types

type PrimSize CUChar :: Nat

Methods

primSizeInBytes :: Proxy * CUChar -> CountOf Word8

primShiftToBytes :: Proxy * CUChar -> Int

primBaUIndex :: ByteArray# -> Offset CUChar -> CUChar

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset CUChar -> prim CUChar

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset CUChar -> CUChar -> prim ()

primAddrIndex :: Addr# -> Offset CUChar -> CUChar

primAddrRead :: PrimMonad prim => Addr# -> Offset CUChar -> prim CUChar

primAddrWrite :: PrimMonad prim => Addr# -> Offset CUChar -> CUChar -> prim ()

PrimType Char7

Associated Types

type PrimSize Char7 :: Nat

Methods

primSizeInBytes :: Proxy * Char7 -> CountOf Word8

primShiftToBytes :: Proxy * Char7 -> Int

primBaUIndex :: ByteArray# -> Offset Char7 -> Char7

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Char7 -> prim Char7

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Char7 -> Char7 -> prim ()

primAddrIndex :: Addr# -> Offset Char7 -> Char7

primAddrRead :: PrimMonad prim => Addr# -> Offset Char7 -> prim Char7

primAddrWrite :: PrimMonad prim => Addr# -> Offset Char7 -> Char7 -> prim ()

PrimType Word128

Associated Types

type PrimSize Word128 :: Nat

Methods

primSizeInBytes :: Proxy * Word128 -> CountOf Word8

primShiftToBytes :: Proxy * Word128 -> Int

primBaUIndex :: ByteArray# -> Offset Word128 -> Word128

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word128 -> prim Word128

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word128 -> Word128 -> prim ()

primAddrIndex :: Addr# -> Offset Word128 -> Word128

primAddrRead :: PrimMonad prim => Addr# -> Offset Word128 -> prim Word128

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word128 -> Word128 -> prim ()

PrimType Word256

Associated Types

type PrimSize Word256 :: Nat

Methods

primSizeInBytes :: Proxy * Word256 -> CountOf Word8

primShiftToBytes :: Proxy * Word256 -> Int

primBaUIndex :: ByteArray# -> Offset Word256 -> Word256

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word256 -> prim Word256

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset Word256 -> Word256 -> prim ()

primAddrIndex :: Addr# -> Offset Word256 -> Word256

primAddrRead :: PrimMonad prim => Addr# -> Offset Word256 -> prim Word256

primAddrWrite :: PrimMonad prim => Addr# -> Offset Word256 -> Word256 -> prim ()

PrimType a => PrimType (BE a)

Associated Types

type PrimSize (BE a) :: Nat

Methods

primSizeInBytes :: Proxy * (BE a) -> CountOf Word8

primShiftToBytes :: Proxy * (BE a) -> Int

primBaUIndex :: ByteArray# -> Offset (BE a) -> BE a

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset (BE a) -> prim (BE a)

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset (BE a) -> BE a -> prim ()

primAddrIndex :: Addr# -> Offset (BE a) -> BE a

primAddrRead :: PrimMonad prim => Addr# -> Offset (BE a) -> prim (BE a)

primAddrWrite :: PrimMonad prim => Addr# -> Offset (BE a) -> BE a -> prim ()

PrimType a => PrimType (LE a)

Associated Types

type PrimSize (LE a) :: Nat

Methods

primSizeInBytes :: Proxy * (LE a) -> CountOf Word8

primShiftToBytes :: Proxy * (LE a) -> Int

primBaUIndex :: ByteArray# -> Offset (LE a) -> LE a

primMbaURead :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset (LE a) -> prim (LE a)

primMbaUWrite :: PrimMonad prim => MutableByteArray# (PrimState prim) -> Offset (LE a) -> LE a -> prim ()

primAddrIndex :: Addr# -> Offset (LE a) -> LE a

primAddrRead :: PrimMonad prim => Addr# -> Offset (LE a) -> prim (LE a)

primAddrWrite :: PrimMonad prim => Addr# -> Offset (LE a) -> LE a -> prim ()

methods

copy :: PrimType ty => UArray ty -> UArray ty

Copy every cells of an existing array to a new array

unsafeCopyAtRO

Arguments

:: (PrimMonad prim, PrimType ty)

=> MUArray ty (PrimState prim)

destination array

-> Offset ty

offset at destination

-> UArray ty

source array

-> Offset ty

offset at source

-> CountOf ty

number of elements to copy

-> prim ()

Copy n sequential elements from the specified offset in a source array to the specified position in a destination array.

This function does not check bounds. Accessing invalid memory can return unpredictable and invalid values.

internal methods

recast :: forall a b. (PrimType a, PrimType b) => UArray a -> UArray b

Recast an array of type a to an array of b

a and b need to have the same size otherwise this raise an async exception

unsafeRecast :: (PrimType a, PrimType b) => UArray a -> UArray b

Unsafely recast an UArray containing a to an UArray containing b

The offset and size are converted from units of a to units of b, but no check are performed to make sure this is compatible.

use recast if unsure.

length :: UArray ty -> CountOf ty

freeze :: (PrimType ty, PrimMonad prim) => MUArray ty (PrimState prim) -> prim (UArray ty)

Freeze a MUArray into a UArray by copying all the content is a pristine new buffer

The MUArray in parameter can be still be used after the call without changing the resulting frozen data.

unsafeFreeze :: PrimMonad prim => MUArray ty (PrimState prim) -> prim (UArray ty)

Freeze a mutable array into an array.

the MUArray must not be changed after freezing.

thaw :: (PrimMonad prim, PrimType ty) => UArray ty -> prim (MUArray ty (PrimState prim))

Thaw an array to a mutable array.

the array is not modified, instead a new mutable array is created and every values is copied, before returning the mutable array.

unsafeThaw :: (PrimType ty, PrimMonad prim) => UArray ty -> prim (MUArray ty (PrimState prim))

Thaw an immutable array.

The UArray must not be used after thawing.

Creation

vFromListN :: forall ty. PrimType ty => CountOf ty -> [ty] -> UArray ty

Make an array from a list of elements with a size hint.

The list should be of the same size as the hint, as otherwise:

• The length of the list is smaller than the hint: the array allocated is of the size of the hint, but is sliced to only represent the valid bits
• The length of the list is bigger than the hint: The allocated array is the size of the hint, and the list is truncated to fit.

new :: (PrimMonad prim, PrimType ty) => CountOf ty -> prim (MUArray ty (PrimState prim))

Create a new mutable array of size @n.

When memory for a new array is allocated, we decide if that memory region should be pinned (will not be copied around by GC) or unpinned (can be moved around by GC) depending on its size.

You can change the threshold value used by setting the environment variable HS_FOUNDATION_UARRAY_UNPINNED_MAX.

create

Arguments

:: PrimType ty

=> CountOf ty

the size of the array

-> (Offset ty -> ty)

the function that set the value at the index

-> UArray ty

the array created

Create a new array of size n by settings each cells through the function f.

createFromIO

Arguments

:: PrimType ty

=> CountOf ty

the size of the array

-> (Ptr ty -> IO (CountOf ty))

filling function that

-> IO (UArray ty)

Create a pinned array that is filled by a filler function (typically an IO call like hGetBuf)

createFromPtr :: PrimType ty => Ptr ty -> CountOf ty -> IO (UArray ty)

Freeze a chunk of memory pointed, of specific size into a new unboxed array

sub :: PrimType ty => UArray ty -> Offset ty -> Offset ty -> UArray ty

copyToPtr

Arguments

:: (PrimType ty, PrimMonad prim)

=> UArray ty

the source array to copy

-> Ptr ty

The destination address where the copy is going to start

-> prim ()

Copy all the block content to the memory starting at the destination address

withPtr :: forall ty prim a. (PrimMonad prim, PrimType ty) => UArray ty -> (Ptr ty -> prim a) -> prim a

Get a Ptr pointing to the data in the UArray.

Since a UArray is immutable, this Ptr shouldn't be to use to modify the contents

If the UArray is pinned, then its address is returned as is, however if it's unpinned, a pinned copy of the UArray is made before getting the address.

withMutablePtr :: (PrimMonad prim, PrimType ty) => MUArray ty (PrimState prim) -> (Ptr ty -> prim a) -> prim a

Create a pointer on the beginning of the mutable array and call a function f.

The mutable buffer can be mutated by the f function and the change will be reflected in the mutable array

If the mutable array is unpinned, a trampoline buffer is created and the data is only copied when f return.

unsafeFreezeShrink :: (PrimType ty, PrimMonad prim) => MUArray ty (PrimState prim) -> CountOf ty -> prim (UArray ty)

freezeShrink :: (PrimType ty, PrimMonad prim) => MUArray ty (PrimState prim) -> CountOf ty -> prim (UArray ty)

Just like freeze but copy only the first n bytes

The size requested need to be smaller or equal to the length of the MUArray, otherwise a Out of Bounds exception is raised

fromBlock :: PrimType ty => Block ty -> UArray ty

Create a UArray from a Block

The block is still used by the uarray

toBlock :: PrimType ty => UArray ty -> Block ty

Create a Block from a UArray.

Note that because of the slice, the destination block is re-allocated and copied, unless the slice point at the whole array

accessors

update :: PrimType ty => UArray ty -> [(Offset ty, ty)] -> UArray ty

update an array by creating a new array with the updates.

the operation copy the previous array, modify it in place, then freeze it.

unsafeUpdate :: PrimType ty => UArray ty -> [(Offset ty, ty)] -> UArray ty

unsafeIndex :: forall ty. PrimType ty => UArray ty -> Offset ty -> ty

Return the element at a specific index from an array without bounds checking.

Reading from invalid memory can return unpredictable and invalid values. use index if unsure.

unsafeIndexer :: (PrimMonad prim, PrimType ty) => UArray ty -> ((Offset ty -> ty) -> prim a) -> prim a

unsafeDewrap :: (Block ty -> Offset ty -> a) -> (Ptr ty -> Offset ty -> ST s a) -> UArray ty -> a

unsafeRead :: (PrimMonad prim, PrimType ty) => MUArray ty (PrimState prim) -> Offset ty -> prim ty

read from a cell in a mutable array without bounds checking.

Reading from invalid memory can return unpredictable and invalid values. use read if unsure.

unsafeWrite :: (PrimMonad prim, PrimType ty) => MUArray ty (PrimState prim) -> Offset ty -> ty -> prim ()

write to a cell in a mutable array without bounds checking.

Writing with invalid bounds will corrupt memory and your program will become unreliable. use write if unsure.

Functions

equalMemcmp :: PrimType ty => UArray ty -> UArray ty -> Bool

singleton :: PrimType ty => ty -> UArray ty

replicate :: PrimType ty => CountOf ty -> ty -> UArray ty

map :: (PrimType a, PrimType b) => (a -> b) -> UArray a -> UArray b

mapIndex :: (PrimType a, PrimType b) => (Offset b -> a -> b) -> UArray a -> UArray b

findIndex :: PrimType ty => ty -> UArray ty -> Maybe (Offset ty)

revFindIndex :: PrimType ty => ty -> UArray ty -> Maybe (Offset ty)

index :: PrimType ty => UArray ty -> Offset ty -> ty

Return the element at a specific index from an array.

If the index @n is out of bounds, an error is raised.

null :: UArray ty -> Bool

take :: CountOf ty -> UArray ty -> UArray ty

Take a count of elements from the array and create an array with just those elements

unsafeTake :: CountOf ty -> UArray ty -> UArray ty

drop :: CountOf ty -> UArray ty -> UArray ty

Drop a count of elements from the array and return the new array minus those dropped elements

unsafeDrop :: CountOf ty -> UArray ty -> UArray ty

splitAt :: CountOf ty -> UArray ty -> (UArray ty, UArray ty)

Split an array into two, with a count of at most N elements in the first one and the remaining in the other.

revDrop :: CountOf ty -> UArray ty -> UArray ty

Drop the N elements from the end of the array

revTake :: CountOf ty -> UArray ty -> UArray ty

Take the N elements from the end of the array

revSplitAt :: CountOf ty -> UArray ty -> (UArray ty, UArray ty)

Split an array at the N element from the end, and return the last N elements in the first part of the tuple, and whatever first elements remaining in the second

splitOn :: PrimType ty => (ty -> Bool) -> UArray ty -> [UArray ty]

break :: forall ty. PrimType ty => (ty -> Bool) -> UArray ty -> (UArray ty, UArray ty)

breakEnd :: forall ty. PrimType ty => (ty -> Bool) -> UArray ty -> (UArray ty, UArray ty)

Similar to break but start the search of the breakpoint from the end

breakEnd (> 0) [1,2,3,0,0,0]

([1,2,3], [0,0,0])

breakElem :: PrimType ty => ty -> UArray ty -> (UArray ty, UArray ty)

breakLine :: UArray Word8 -> Either Bool (UArray Word8, UArray Word8)

Similar to breakElem specialized to split on linefeed

it either returns: * Left. no line has been found, and whether the last character is a CR * Right, a line has been found with an optional CR, and it returns the array of bytes on the left of the CR/LF, and the the array of bytes on the right of the LF.

elem :: PrimType ty => ty -> UArray ty -> Bool

indices :: PrimType ty => UArray ty -> UArray ty -> [Offset ty]

intersperse :: forall ty. PrimType ty => ty -> UArray ty -> UArray ty

span :: PrimType ty => (ty -> Bool) -> UArray ty -> (UArray ty, UArray ty)

spanEnd :: PrimType ty => (ty -> Bool) -> UArray ty -> (UArray ty, UArray ty)

cons :: PrimType ty => ty -> UArray ty -> UArray ty

snoc :: PrimType ty => UArray ty -> ty -> UArray ty

uncons :: PrimType ty => UArray ty -> Maybe (ty, UArray ty)

unsnoc :: PrimType ty => UArray ty -> Maybe (UArray ty, ty)

find :: PrimType ty => (ty -> Bool) -> UArray ty -> Maybe ty

sortBy :: forall ty. PrimType ty => (ty -> ty -> Ordering) -> UArray ty -> UArray ty

filter :: forall ty. PrimType ty => (ty -> Bool) -> UArray ty -> UArray ty

reverse :: forall ty. PrimType ty => UArray ty -> UArray ty

replace :: PrimType ty => UArray ty -> UArray ty -> UArray ty -> UArray ty

Replace all the occurrencies of needle with replacement in the haystack string.

foldr :: PrimType ty => (ty -> a -> a) -> a -> UArray ty -> a

foldl' :: PrimType ty => (a -> ty -> a) -> a -> UArray ty -> a

foldr1 :: PrimType ty => (ty -> ty -> ty) -> NonEmpty (UArray ty) -> ty

foldl1' :: PrimType ty => (ty -> ty -> ty) -> NonEmpty (UArray ty) -> ty

all :: PrimType ty => (ty -> Bool) -> UArray ty -> Bool

any :: PrimType ty => (ty -> Bool) -> UArray ty -> Bool

isPrefixOf :: PrimType ty => UArray ty -> UArray ty -> Bool

isSuffixOf :: PrimType ty => UArray ty -> UArray ty -> Bool

foreignMem

Arguments

:: PrimType ty

=> FinalPtr ty

the start pointer with a finalizer

-> CountOf ty

the number of elements (in elements, not bytes)

-> UArray ty

fromForeignPtr :: PrimType ty => (ForeignPtr ty, Int, Int) -> UArray ty

Create a foreign UArray from foreign memory and given offset/size

No check are performed to make sure this is valid, so this is unsafe.

This is particularly useful when dealing with foreign memory and ByteString

builderAppend :: (PrimType ty, PrimMonad state) => ty -> Builder (UArray ty) (MUArray ty) ty state err ()

builderBuild :: (PrimType ty, PrimMonad m) => Int -> Builder (UArray ty) (MUArray ty) ty m err () -> m (Either err (UArray ty))

builderBuild_ :: (PrimType ty, PrimMonad m) => Int -> Builder (UArray ty) (MUArray ty) ty m () () -> m (UArray ty)

toHexadecimal :: PrimType ty => UArray ty -> UArray Word8

toBase64Internal :: PrimType ty => Addr# -> UArray ty -> Bool -> UArray Word8