Data.Vector.Fixed.Storable

Storable-based unboxed vectors.

Immutable

data Vec (n :: Nat) a

Storable-based vector with fixed length

Instances

(Arity n, Storable a) => VectorN Vec n a

(Arity n, Storable a) => Vector (Vec n) a

Methods

construct :: Fun (Peano (Dim (Vec n))) a (Vec n a)

inspect :: Vec n a -> Fun (Peano (Dim (Vec n))) a b -> b

basicIndex :: Vec n a -> Int -> a

(Arity n, Storable a) => IVector (Vec n) a

Methods

unsafeFreeze :: PrimMonad m => Mutable (Vec n) (PrimState m) a -> m (Vec n a)

unsafeThaw :: PrimMonad m => Vec n a -> m (Mutable (Vec n) (PrimState m) a)

unsafeIndex :: Vec n a -> Int -> a

(Arity n, Storable a, Eq a) => Eq (Vec n a)

Methods

(==) :: Vec n a -> Vec n a -> Bool

(/=) :: Vec n a -> Vec n a -> Bool

(Typeable Nat n, Arity n, Storable a, Data a) => Data (Vec n a)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Vec n a -> c (Vec n a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Vec n a)

toConstr :: Vec n a -> Constr

dataTypeOf :: Vec n a -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (Vec n a))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Vec n a))

gmapT :: (forall b. Data b => b -> b) -> Vec n a -> Vec n a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Vec n a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Vec n a -> r

gmapQ :: (forall d. Data d => d -> u) -> Vec n a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Vec n a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Vec n a -> m (Vec n a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Vec n a -> m (Vec n a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Vec n a -> m (Vec n a)

(Arity n, Storable a, Ord a) => Ord (Vec n a)

Methods

compare :: Vec n a -> Vec n a -> Ordering

(<) :: Vec n a -> Vec n a -> Bool

(<=) :: Vec n a -> Vec n a -> Bool

(>) :: Vec n a -> Vec n a -> Bool

(>=) :: Vec n a -> Vec n a -> Bool

max :: Vec n a -> Vec n a -> Vec n a

min :: Vec n a -> Vec n a -> Vec n a

(Arity n, Storable a, Show a) => Show (Vec n a)

Methods

showsPrec :: Int -> Vec n a -> ShowS

show :: Vec n a -> String

showList :: [Vec n a] -> ShowS

(Arity n, Storable a, Semigroup a) => Semigroup (Vec n a)

Methods

(<>) :: Vec n a -> Vec n a -> Vec n a

sconcat :: NonEmpty (Vec n a) -> Vec n a

stimes :: Integral b => b -> Vec n a -> Vec n a

(Arity n, Storable a, Monoid a) => Monoid (Vec n a)

Methods

mempty :: Vec n a

mappend :: Vec n a -> Vec n a -> Vec n a

mconcat :: [Vec n a] -> Vec n a

(Arity n, Storable a) => Storable (Vec n a)

Methods

sizeOf :: Vec n a -> Int

alignment :: Vec n a -> Int

peekElemOff :: Ptr (Vec n a) -> Int -> IO (Vec n a)

pokeElemOff :: Ptr (Vec n a) -> Int -> Vec n a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Vec n a)

pokeByteOff :: Ptr b -> Int -> Vec n a -> IO ()

peek :: Ptr (Vec n a) -> IO (Vec n a)

poke :: Ptr (Vec n a) -> Vec n a -> IO ()

(Arity n, Storable a, NFData a) => NFData (Vec n a)

Methods

rnf :: Vec n a -> ()

type Dim (Vec n)

type Dim (Vec n) = n

type Mutable (Vec n)

type Mutable (Vec n) = MVec n

type Vec1 = Vec 1

type Vec2 = Vec 2

type Vec3 = Vec 3

type Vec4 = Vec 4

type Vec5 = Vec 5

Raw pointers

unsafeFromForeignPtr :: ForeignPtr a -> Vec n a

Construct vector from foreign pointer.

unsafeToForeignPtr :: Vec n a -> ForeignPtr a

Get underlying pointer. Data may not be modified through pointer.

unsafeWith :: (Ptr a -> IO b) -> Vec n a -> IO b

Mutable

newtype MVec (n :: Nat) s a

Storable-based mutable vector with fixed length

Constructors

MVec (ForeignPtr a)

Instances

(Arity n, Storable a) => MVector (MVec n) a

Methods

copy :: PrimMonad m => MVec n (PrimState m) a -> MVec n (PrimState m) a -> m ()

move :: PrimMonad m => MVec n (PrimState m) a -> MVec n (PrimState m) a -> m ()

new :: PrimMonad m => m (MVec n (PrimState m) a)

unsafeRead :: PrimMonad m => MVec n (PrimState m) a -> Int -> m a

unsafeWrite :: PrimMonad m => MVec n (PrimState m) a -> Int -> a -> m ()

type DimM (MVec n)

type DimM (MVec n) = n

Type classes

class Storable a

The member functions of this class facilitate writing values of primitive types to raw memory (which may have been allocated with the above mentioned routines) and reading values from blocks of raw memory. The class, furthermore, includes support for computing the storage requirements and alignment restrictions of storable types.

Memory addresses are represented as values of type Ptr a, for some a which is an instance of class Storable. The type argument to Ptr helps provide some valuable type safety in FFI code (you can't mix pointers of different types without an explicit cast), while helping the Haskell type system figure out which marshalling method is needed for a given pointer.

All marshalling between Haskell and a foreign language ultimately boils down to translating Haskell data structures into the binary representation of a corresponding data structure of the foreign language and vice versa. To code this marshalling in Haskell, it is necessary to manipulate primitive data types stored in unstructured memory blocks. The class Storable facilitates this manipulation on all types for which it is instantiated, which are the standard basic types of Haskell, the fixed size Int types (Int8, Int16, Int32, Int64), the fixed size Word types (Word8, Word16, Word32, Word64), StablePtr, all types from Foreign.C.Types, as well as Ptr.

Minimal complete definition

sizeOf, alignment, (peek | peekElemOff | peekByteOff), (poke | pokeElemOff | pokeByteOff)

Instances

Storable Bool

Since: 2.1

Methods

sizeOf :: Bool -> Int

alignment :: Bool -> Int

peekElemOff :: Ptr Bool -> Int -> IO Bool

pokeElemOff :: Ptr Bool -> Int -> Bool -> IO ()

peekByteOff :: Ptr b -> Int -> IO Bool

pokeByteOff :: Ptr b -> Int -> Bool -> IO ()

peek :: Ptr Bool -> IO Bool

poke :: Ptr Bool -> Bool -> IO ()

Storable Char

Since: 2.1

Methods

sizeOf :: Char -> Int

alignment :: Char -> Int

peekElemOff :: Ptr Char -> Int -> IO Char

pokeElemOff :: Ptr Char -> Int -> Char -> IO ()

peekByteOff :: Ptr b -> Int -> IO Char

pokeByteOff :: Ptr b -> Int -> Char -> IO ()

peek :: Ptr Char -> IO Char

poke :: Ptr Char -> Char -> IO ()

Storable Double

Since: 2.1

Methods

sizeOf :: Double -> Int

alignment :: Double -> Int

peekElemOff :: Ptr Double -> Int -> IO Double

pokeElemOff :: Ptr Double -> Int -> Double -> IO ()

peekByteOff :: Ptr b -> Int -> IO Double

pokeByteOff :: Ptr b -> Int -> Double -> IO ()

peek :: Ptr Double -> IO Double

poke :: Ptr Double -> Double -> IO ()

Storable Float

Since: 2.1

Methods

sizeOf :: Float -> Int

alignment :: Float -> Int

peekElemOff :: Ptr Float -> Int -> IO Float

pokeElemOff :: Ptr Float -> Int -> Float -> IO ()

peekByteOff :: Ptr b -> Int -> IO Float

pokeByteOff :: Ptr b -> Int -> Float -> IO ()

peek :: Ptr Float -> IO Float

poke :: Ptr Float -> Float -> IO ()

Storable Int

Since: 2.1

Methods

sizeOf :: Int -> Int

alignment :: Int -> Int

peekElemOff :: Ptr Int -> Int -> IO Int

pokeElemOff :: Ptr Int -> Int -> Int -> IO ()

peekByteOff :: Ptr b -> Int -> IO Int

pokeByteOff :: Ptr b -> Int -> Int -> IO ()

peek :: Ptr Int -> IO Int

poke :: Ptr Int -> Int -> IO ()

Storable Int8

Since: 2.1

Methods

sizeOf :: Int8 -> Int

alignment :: Int8 -> Int

peekElemOff :: Ptr Int8 -> Int -> IO Int8

pokeElemOff :: Ptr Int8 -> Int -> Int8 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Int8

pokeByteOff :: Ptr b -> Int -> Int8 -> IO ()

peek :: Ptr Int8 -> IO Int8

poke :: Ptr Int8 -> Int8 -> IO ()

Storable Int16

Since: 2.1

Methods

sizeOf :: Int16 -> Int

alignment :: Int16 -> Int

peekElemOff :: Ptr Int16 -> Int -> IO Int16

pokeElemOff :: Ptr Int16 -> Int -> Int16 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Int16

pokeByteOff :: Ptr b -> Int -> Int16 -> IO ()

peek :: Ptr Int16 -> IO Int16

poke :: Ptr Int16 -> Int16 -> IO ()

Storable Int32

Since: 2.1

Methods

sizeOf :: Int32 -> Int

alignment :: Int32 -> Int

peekElemOff :: Ptr Int32 -> Int -> IO Int32

pokeElemOff :: Ptr Int32 -> Int -> Int32 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Int32

pokeByteOff :: Ptr b -> Int -> Int32 -> IO ()

peek :: Ptr Int32 -> IO Int32

poke :: Ptr Int32 -> Int32 -> IO ()

Storable Int64

Since: 2.1

Methods

sizeOf :: Int64 -> Int

alignment :: Int64 -> Int

peekElemOff :: Ptr Int64 -> Int -> IO Int64

pokeElemOff :: Ptr Int64 -> Int -> Int64 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Int64

pokeByteOff :: Ptr b -> Int -> Int64 -> IO ()

peek :: Ptr Int64 -> IO Int64

poke :: Ptr Int64 -> Int64 -> IO ()

Storable Word

Since: 2.1

Methods

sizeOf :: Word -> Int

alignment :: Word -> Int

peekElemOff :: Ptr Word -> Int -> IO Word

pokeElemOff :: Ptr Word -> Int -> Word -> IO ()

peekByteOff :: Ptr b -> Int -> IO Word

pokeByteOff :: Ptr b -> Int -> Word -> IO ()

peek :: Ptr Word -> IO Word

poke :: Ptr Word -> Word -> IO ()

Storable Word8

Since: 2.1

Methods

sizeOf :: Word8 -> Int

alignment :: Word8 -> Int

peekElemOff :: Ptr Word8 -> Int -> IO Word8

pokeElemOff :: Ptr Word8 -> Int -> Word8 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Word8

pokeByteOff :: Ptr b -> Int -> Word8 -> IO ()

peek :: Ptr Word8 -> IO Word8

poke :: Ptr Word8 -> Word8 -> IO ()

Storable Word16

Since: 2.1

Methods

sizeOf :: Word16 -> Int

alignment :: Word16 -> Int

peekElemOff :: Ptr Word16 -> Int -> IO Word16

pokeElemOff :: Ptr Word16 -> Int -> Word16 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Word16

pokeByteOff :: Ptr b -> Int -> Word16 -> IO ()

peek :: Ptr Word16 -> IO Word16

poke :: Ptr Word16 -> Word16 -> IO ()

Storable Word32

Since: 2.1

Methods

sizeOf :: Word32 -> Int

alignment :: Word32 -> Int

peekElemOff :: Ptr Word32 -> Int -> IO Word32

pokeElemOff :: Ptr Word32 -> Int -> Word32 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Word32

pokeByteOff :: Ptr b -> Int -> Word32 -> IO ()

peek :: Ptr Word32 -> IO Word32

poke :: Ptr Word32 -> Word32 -> IO ()

Storable Word64

Since: 2.1

Methods

sizeOf :: Word64 -> Int

alignment :: Word64 -> Int

peekElemOff :: Ptr Word64 -> Int -> IO Word64

pokeElemOff :: Ptr Word64 -> Int -> Word64 -> IO ()

peekByteOff :: Ptr b -> Int -> IO Word64

pokeByteOff :: Ptr b -> Int -> Word64 -> IO ()

peek :: Ptr Word64 -> IO Word64

poke :: Ptr Word64 -> Word64 -> IO ()

Storable ()

Since: 4.9.0.0

Methods

sizeOf :: () -> Int

alignment :: () -> Int

peekElemOff :: Ptr () -> Int -> IO ()

pokeElemOff :: Ptr () -> Int -> () -> IO ()

peekByteOff :: Ptr b -> Int -> IO ()

pokeByteOff :: Ptr b -> Int -> () -> IO ()

peek :: Ptr () -> IO ()

poke :: Ptr () -> () -> IO ()

Storable WordPtr

Methods

sizeOf :: WordPtr -> Int

alignment :: WordPtr -> Int

peekElemOff :: Ptr WordPtr -> Int -> IO WordPtr

pokeElemOff :: Ptr WordPtr -> Int -> WordPtr -> IO ()

peekByteOff :: Ptr b -> Int -> IO WordPtr

pokeByteOff :: Ptr b -> Int -> WordPtr -> IO ()

peek :: Ptr WordPtr -> IO WordPtr

poke :: Ptr WordPtr -> WordPtr -> IO ()

Storable IntPtr

Methods

sizeOf :: IntPtr -> Int

alignment :: IntPtr -> Int

peekElemOff :: Ptr IntPtr -> Int -> IO IntPtr

pokeElemOff :: Ptr IntPtr -> Int -> IntPtr -> IO ()

peekByteOff :: Ptr b -> Int -> IO IntPtr

pokeByteOff :: Ptr b -> Int -> IntPtr -> IO ()

peek :: Ptr IntPtr -> IO IntPtr

poke :: Ptr IntPtr -> IntPtr -> IO ()

Storable Fingerprint

Since: 4.4.0.0

Methods

sizeOf :: Fingerprint -> Int

alignment :: Fingerprint -> Int

peekElemOff :: Ptr Fingerprint -> Int -> IO Fingerprint

pokeElemOff :: Ptr Fingerprint -> Int -> Fingerprint -> IO ()

peekByteOff :: Ptr b -> Int -> IO Fingerprint

pokeByteOff :: Ptr b -> Int -> Fingerprint -> IO ()

peek :: Ptr Fingerprint -> IO Fingerprint

poke :: Ptr Fingerprint -> Fingerprint -> IO ()

(Storable a, Integral a) => Storable (Ratio a)

Since: 4.8.0.0

Methods

sizeOf :: Ratio a -> Int

alignment :: Ratio a -> Int

peekElemOff :: Ptr (Ratio a) -> Int -> IO (Ratio a)

pokeElemOff :: Ptr (Ratio a) -> Int -> Ratio a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Ratio a)

pokeByteOff :: Ptr b -> Int -> Ratio a -> IO ()

peek :: Ptr (Ratio a) -> IO (Ratio a)

poke :: Ptr (Ratio a) -> Ratio a -> IO ()

Storable (StablePtr a)

Since: 2.1

Methods

sizeOf :: StablePtr a -> Int

alignment :: StablePtr a -> Int

peekElemOff :: Ptr (StablePtr a) -> Int -> IO (StablePtr a)

pokeElemOff :: Ptr (StablePtr a) -> Int -> StablePtr a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (StablePtr a)

pokeByteOff :: Ptr b -> Int -> StablePtr a -> IO ()

peek :: Ptr (StablePtr a) -> IO (StablePtr a)

poke :: Ptr (StablePtr a) -> StablePtr a -> IO ()

Storable (Ptr a)

Since: 2.1

Methods

sizeOf :: Ptr a -> Int

alignment :: Ptr a -> Int

peekElemOff :: Ptr (Ptr a) -> Int -> IO (Ptr a)

pokeElemOff :: Ptr (Ptr a) -> Int -> Ptr a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Ptr a)

pokeByteOff :: Ptr b -> Int -> Ptr a -> IO ()

peek :: Ptr (Ptr a) -> IO (Ptr a)

poke :: Ptr (Ptr a) -> Ptr a -> IO ()

Storable (FunPtr a)

Since: 2.1

Methods

sizeOf :: FunPtr a -> Int

alignment :: FunPtr a -> Int

peekElemOff :: Ptr (FunPtr a) -> Int -> IO (FunPtr a)

pokeElemOff :: Ptr (FunPtr a) -> Int -> FunPtr a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (FunPtr a)

pokeByteOff :: Ptr b -> Int -> FunPtr a -> IO ()

peek :: Ptr (FunPtr a) -> IO (FunPtr a)

poke :: Ptr (FunPtr a) -> FunPtr a -> IO ()

Storable a => Storable (Complex a)

Since: 4.8.0.0

Methods

sizeOf :: Complex a -> Int

alignment :: Complex a -> Int

peekElemOff :: Ptr (Complex a) -> Int -> IO (Complex a)

pokeElemOff :: Ptr (Complex a) -> Int -> Complex a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Complex a)

pokeByteOff :: Ptr b -> Int -> Complex a -> IO ()

peek :: Ptr (Complex a) -> IO (Complex a)

poke :: Ptr (Complex a) -> Complex a -> IO ()

Storable a => Storable (Identity a)

Methods

sizeOf :: Identity a -> Int

alignment :: Identity a -> Int

peekElemOff :: Ptr (Identity a) -> Int -> IO (Identity a)

pokeElemOff :: Ptr (Identity a) -> Int -> Identity a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Identity a)

pokeByteOff :: Ptr b -> Int -> Identity a -> IO ()

peek :: Ptr (Identity a) -> IO (Identity a)

poke :: Ptr (Identity a) -> Identity a -> IO ()

Storable a => Storable (Only a)

Methods

sizeOf :: Only a -> Int

alignment :: Only a -> Int

peekElemOff :: Ptr (Only a) -> Int -> IO (Only a)

pokeElemOff :: Ptr (Only a) -> Int -> Only a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Only a)

pokeByteOff :: Ptr b -> Int -> Only a -> IO ()

peek :: Ptr (Only a) -> IO (Only a)

poke :: Ptr (Only a) -> Only a -> IO ()

(Storable a, Arity n) => Storable (VecList n a)

Methods

sizeOf :: VecList n a -> Int

alignment :: VecList n a -> Int

peekElemOff :: Ptr (VecList n a) -> Int -> IO (VecList n a)

pokeElemOff :: Ptr (VecList n a) -> Int -> VecList n a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (VecList n a)

pokeByteOff :: Ptr b -> Int -> VecList n a -> IO ()

peek :: Ptr (VecList n a) -> IO (VecList n a)

poke :: Ptr (VecList n a) -> VecList n a -> IO ()

(Storable a, Arity n) => Storable (Vec n a)

Methods

sizeOf :: Vec n a -> Int

alignment :: Vec n a -> Int

peekElemOff :: Ptr (Vec n a) -> Int -> IO (Vec n a)

pokeElemOff :: Ptr (Vec n a) -> Int -> Vec n a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Vec n a)

pokeByteOff :: Ptr b -> Int -> Vec n a -> IO ()

peek :: Ptr (Vec n a) -> IO (Vec n a)

poke :: Ptr (Vec n a) -> Vec n a -> IO ()

(Storable a, Prim a, Arity n) => Storable (Vec n a)

Methods

sizeOf :: Vec n a -> Int

alignment :: Vec n a -> Int

peekElemOff :: Ptr (Vec n a) -> Int -> IO (Vec n a)

pokeElemOff :: Ptr (Vec n a) -> Int -> Vec n a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Vec n a)

pokeByteOff :: Ptr b -> Int -> Vec n a -> IO ()

peek :: Ptr (Vec n a) -> IO (Vec n a)

poke :: Ptr (Vec n a) -> Vec n a -> IO ()

(Arity n, Storable a) => Storable (Vec n a)

Methods

sizeOf :: Vec n a -> Int

alignment :: Vec n a -> Int

peekElemOff :: Ptr (Vec n a) -> Int -> IO (Vec n a)

pokeElemOff :: Ptr (Vec n a) -> Int -> Vec n a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Vec n a)

pokeByteOff :: Ptr b -> Int -> Vec n a -> IO ()

peek :: Ptr (Vec n a) -> IO (Vec n a)

poke :: Ptr (Vec n a) -> Vec n a -> IO ()

(Storable a, Unbox n a) => Storable (Vec n a)

Methods

sizeOf :: Vec n a -> Int

alignment :: Vec n a -> Int

peekElemOff :: Ptr (Vec n a) -> Int -> IO (Vec n a)

pokeElemOff :: Ptr (Vec n a) -> Int -> Vec n a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Vec n a)

pokeByteOff :: Ptr b -> Int -> Vec n a -> IO ()

peek :: Ptr (Vec n a) -> IO (Vec n a)

poke :: Ptr (Vec n a) -> Vec n a -> IO ()

Storable a => Storable (Const k a b)

Methods

sizeOf :: Const k a b -> Int

alignment :: Const k a b -> Int

peekElemOff :: Ptr (Const k a b) -> Int -> IO (Const k a b)

pokeElemOff :: Ptr (Const k a b) -> Int -> Const k a b -> IO ()

peekByteOff :: Ptr b -> Int -> IO (Const k a b)

pokeByteOff :: Ptr b -> Int -> Const k a b -> IO ()

peek :: Ptr (Const k a b) -> IO (Const k a b)

poke :: Ptr (Const k a b) -> Const k a b -> IO ()