CLaSH.Class.BitPack

Documentation

class BitPack a where

Convert to and from a BitVector

Minimal complete definition

pack, unpack

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

Associated Types

type BitSize Bool :: Nat

Methods

pack :: Bool -> BitVector (BitSize Bool)

unpack :: BitVector (BitSize Bool) -> Bool

KnownNat n => BitPack (Index n)

Associated Types

type BitSize (Index n) :: Nat

Methods

pack :: Index n -> BitVector (BitSize (Index n))

unpack :: BitVector (BitSize (Index n)) -> Index n

BitPack (BitVector n)

Associated Types

type BitSize (BitVector n) :: Nat

Methods

pack :: BitVector n -> BitVector (BitSize (BitVector n))

unpack :: BitVector (BitSize (BitVector n)) -> BitVector n

KnownNat n => BitPack (Signed n)

Associated Types

type BitSize (Signed n) :: Nat

Methods

pack :: Signed n -> BitVector (BitSize (Signed n))

unpack :: BitVector (BitSize (Signed n)) -> Signed n

BitPack (Unsigned n)

Associated Types

type BitSize (Unsigned n) :: Nat

Methods

pack :: Unsigned n -> BitVector (BitSize (Unsigned n))

unpack :: BitVector (BitSize (Unsigned n)) -> Unsigned n

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

Associated Types

type BitSize (a, b) :: Nat

Methods

pack :: (a, b) -> BitVector (BitSize (a, b))

unpack :: BitVector (BitSize (a, b)) -> (a, b)

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

Associated Types

type BitSize (Vec n a) :: Nat

Methods

pack :: Vec n a -> BitVector (BitSize (Vec n a))

unpack :: BitVector (BitSize (Vec n a)) -> Vec n a

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

Associated Types

type BitSize (a, b, c) :: Nat

Methods

pack :: (a, b, c) -> BitVector (BitSize (a, b, c))

unpack :: BitVector (BitSize (a, b, c)) -> (a, b, c)

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

Associated Types

type BitSize (Fixed rep int frac) :: Nat

Methods

pack :: Fixed rep int frac -> BitVector (BitSize (Fixed rep int frac))

unpack :: BitVector (BitSize (Fixed rep int frac)) -> Fixed rep int frac

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

Associated Types

type BitSize (a, b, c, d) :: Nat

Methods

pack :: (a, b, c, d) -> BitVector (BitSize (a, b, c, d))

unpack :: BitVector (BitSize (a, b, c, d)) -> (a, b, c, d)

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

Associated Types

type BitSize (a, b, c, d, e) :: Nat

Methods

pack :: (a, b, c, d, e) -> BitVector (BitSize (a, b, c, d, e))

unpack :: BitVector (BitSize (a, b, c, d, e)) -> (a, b, c, d, e)

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

Associated Types

type BitSize (a, b, c, d, e, f) :: Nat

Methods

pack :: (a, b, c, d, e, f) -> BitVector (BitSize (a, b, c, d, e, f))

unpack :: BitVector (BitSize (a, b, c, d, e, f)) -> (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)

Associated Types

type BitSize (a, b, c, d, e, f, g) :: Nat

Methods

pack :: (a, b, c, d, e, f, g) -> BitVector (BitSize (a, b, c, d, e, f, g))

unpack :: BitVector (BitSize (a, b, c, d, e, f, g)) -> (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)

Associated Types

type BitSize (a, b, c, d, e, f, g, h) :: Nat

Methods

pack :: (a, b, c, d, e, f, g, h) -> BitVector (BitSize (a, b, c, d, e, f, g, h))

unpack :: BitVector (BitSize (a, b, c, d, e, f, g, h)) -> (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