Ivory.BitData.Array

Documentation

type family ArraySize n a :: Nat

data BitArray n a

An array of n bit data elements of type a.

Constructors

BitArray

Fields

unArray :: Bits (ArraySize n a)

Instances

(SingI Nat n, SingI Nat (ArraySize n a), BitData a, IvoryRep (BitRep (ArraySize n a))) => BitData (BitArray n a)

bitLength :: forall a n. SingI n => BitArray n a -> Int

Return the number of elements in a BitArray.

(#!) :: forall a n. (BitData a, SingI n, SingI (BitSize a), SingI (ArraySize n a), BitCast (BitRep (ArraySize n a)) (BitDataRep a), IvoryRep (BitRep (ArraySize n a))) => BitArray n a -> Int -> a

Return the nth element of a BitArray.

bitIx :: forall a n. (BitData a, SingI n, SingI (BitSize a), SingI (ArraySize n a)) => Int -> BitDataField (BitArray n a) a

Return a BitDataField that accesses the nth element of a BitArray. This can be composed with other field accessors using .