CLaSH.Class.BitPack

Documentation

class BitPack a where

Convert to and from a BitVector

Associated Types

type BitSize a :: Nat

Number of Bits needed to represents elements of type a

Methods

pack :: a -> BitVector (BitSize a)

Convert element of type a to a BitVector

>>> pack (-5 :: Signed 6)
11_1011

unpack :: BitVector (BitSize a) -> a

Convert a BitVector to an element of type a

>>> pack (-5 :: Signed 6)
11_1011
>>> let x = pack (-5 :: Signed 6)
>>> unpack x :: Unsigned 6
59
>>> pack (59 :: Unsigned 6)
11_1011

Instances

BitPack Bool

KnownNat n => BitPack (Index n)

BitPack (BitVector n)

KnownNat n => BitPack (Signed n)

BitPack (Unsigned n)

(KnownNat (BitSize b), BitPack a, BitPack b) => BitPack (a, b)

(KnownNat n, KnownNat (BitSize a), BitPack a) => BitPack (Vec n a)

(KnownNat (BitSize c), BitPack (a, b), BitPack c) => BitPack (a, b, c)

BitPack (rep ((+) int frac)) => BitPack (Fixed rep int frac)

(KnownNat (BitSize d), BitPack (a, b, c), BitPack d) => BitPack (a, b, c, d)

(KnownNat (BitSize e), BitPack (a, b, c, d), BitPack e) => BitPack (a, b, c, d, e)

(KnownNat (BitSize f), BitPack (a, b, c, d, e), BitPack f) => BitPack (a, b, c, d, e, f)

(KnownNat (BitSize g), BitPack (a, b, c, d, e, f), BitPack g) => BitPack (a, b, c, d, e, f, g)

(KnownNat (BitSize h), BitPack (a, b, c, d, e, f, g), BitPack h) => BitPack (a, b, c, d, e, f, g, h)

bitCoerce :: (BitPack a, BitPack b, BitSize a ~ BitSize b) => a -> b

Coerce a value from one type to another through its bit representation.

>>> pack (-5 :: Signed 6)
11_1011
>>> bitCoerce (-5 :: Signed 6) :: Unsigned 6
59
>>> pack (59 :: Unsigned 6)
11_1011

boolToBV :: (KnownNat n, KnownNat (n + 1)) => Bool -> BitVector (n + 1)

Zero-extend a Boolean value to a BitVector of the appropriate size.

>>> boolToBV True :: BitVector 6
00_0001
>>> boolToBV False :: BitVector 6
00_0000