Ivory.Language.BitData.Array

Documentation

type family ArraySize (n :: Nat) (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

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

Associated Types

type BitType (BitArray n a) :: *

Methods

toBits :: BitArray n a -> BitType (BitArray n a)

fromBits :: BitType (BitArray n a) -> BitArray n a

type BitType (BitArray n a)

type BitType (BitArray n a) = Bits (ArraySize n a)

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

Return the number of elements in a BitArray.

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

Return the "n"th element of a BitArray.

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

Return a BitDataField that accesses the "n"th element of a BitArray. This can be composed with other field accessors using "#>".