primitive-0.3: Wrappers for primitive operations Source code Contents Index

Data.Primitive.Types Portability non-portable Maintainer Roman Leshchinskiy <rl@cse.unsw.edu.au>

Description

Basic types and classes for primitive array operations

Synopsis

class Prim a where sizeOf# :: a -> Int# alignment# :: a -> Int# indexByteArray# :: ByteArray# -> Int# -> a readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, a#) writeByteArray# :: MutableByteArray# s -> Int# -> a -> State# s -> State# s indexOffAddr# :: Addr# -> Int# -> a readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, a#) writeOffAddr# :: Addr# -> Int# -> a -> State# s -> State# s data Addr = Addr Addr#

Documentation

class Prim a where Source

Class of types supporting primitive array operations Methods sizeOf# :: a -> Int# Source Size of values of type a. The argument is not used. alignment# :: a -> Int# Source Alignment of values of type a. The argument is not used. indexByteArray# :: ByteArray# -> Int# -> a Source Read a value from the array. The offset is in elements of type a rather than in bytes. readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, a#) Source Read a value from the mutable array. The offset is in elements of type a rather than in bytes. writeByteArray# :: MutableByteArray# s -> Int# -> a -> State# s -> State# s Source Write a value to the mutable array. The offset is in elements of type a rather than in bytes. indexOffAddr# :: Addr# -> Int# -> a Source Read a value from a memory position given by an address and an offset. The memory block the address refers to must be immutable. The offset is in elements of type a rather than in bytes. readOffAddr# :: Addr# -> Int# -> State# s -> (#State# s, a#) Source Read a value from a memory position given by an address and an offset. The offset is in elements of type a rather than in bytes. writeOffAddr# :: Addr# -> Int# -> a -> State# s -> State# s Source Write a value to a memory position given by an address and an offset. The offset is in elements of type a rather than in bytes.

data Addr Source

A machine address Constructors Addr Addr#

Produced by Haddock version 2.6.0