Clash.Signal.Delayed.Bundle

Documentation

class Bundle a

Isomorphism between a DSignal of a product type (e.g. a tuple) and a product type of DSignals.

Instances of Bundle must satisfy the following laws:

bundle . unbundle = id
unbundle . bundle = id

By default, bundle and unbundle, are defined as the identity, that is, writing:

data D = A | B

instance Bundle D

is the same as:

data D = A | B

instance Bundle D where
  type Unbundled dom delay D = DSignal dom delay D
  bundle   s = s
  unbundle s = s

Instances

Bundle Bool

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d Bool = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Bool -> DSignal dom d Bool

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Bool -> Unbundled dom d Bool

Bundle Double

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d Double = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Double -> DSignal dom d Double

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Double -> Unbundled dom d Double

Bundle Float

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d Float = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Float -> DSignal dom d Float

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Float -> Unbundled dom d Float

Bundle Int

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d Int = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Int -> DSignal dom d Int

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Int -> Unbundled dom d Int

Bundle Integer

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d Integer = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Integer -> DSignal dom d Integer

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Integer -> Unbundled dom d Integer

Bundle ()

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d () = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d () -> DSignal dom d ()

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d () -> Unbundled dom d ()

Bundle Bit

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d Bit = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d Bit -> DSignal dom d Bit

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d Bit -> Unbundled dom d Bit

Bundle (Maybe a)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Maybe a) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Maybe a) -> DSignal dom d (Maybe a)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Maybe a) -> Unbundled dom d (Maybe a)

Bundle (BitVector n)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (BitVector n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (BitVector n) -> DSignal dom d (BitVector n)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (BitVector n) -> Unbundled dom d (BitVector n)

Bundle (Index n)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Index n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Index n) -> DSignal dom d (Index n)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Index n) -> Unbundled dom d (Index n)

Bundle (Unsigned n)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Unsigned n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Unsigned n) -> DSignal dom d (Unsigned n)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Unsigned n) -> Unbundled dom d (Unsigned n)

Bundle (Signed n)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Signed n) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Signed n) -> DSignal dom d (Signed n)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Signed n) -> Unbundled dom d (Signed n)

Bundle (Either a b)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Either a b) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Either a b) -> DSignal dom d (Either a b)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Either a b) -> Unbundled dom d (Either a b)

Bundle (a, b)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (a, b) -> DSignal dom d (a, b)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (a, b) -> Unbundled dom d (a, b)

KnownNat n => Bundle (Vec n a)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Vec n a) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Vec n a) -> DSignal dom d (Vec n a)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Vec n a) -> Unbundled dom d (Vec n a)

KnownNat d => Bundle (RTree d a)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (RTree d a) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d0 :: Nat). Unbundled dom d0 (RTree d a) -> DSignal dom d0 (RTree d a)

unbundle :: forall (dom :: Domain) (d0 :: Nat). DSignal dom d0 (RTree d a) -> Unbundled dom d0 (RTree d a)

Bundle (a, b, c)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b, c) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (a, b, c) -> DSignal dom d (a, b, c)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (a, b, c) -> Unbundled dom d (a, b, c)

Bundle (Fixed rep int frac)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (Fixed rep int frac) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d :: Nat). Unbundled dom d (Fixed rep int frac) -> DSignal dom d (Fixed rep int frac)

unbundle :: forall (dom :: Domain) (d :: Nat). DSignal dom d (Fixed rep int frac) -> Unbundled dom d (Fixed rep int frac)

Bundle (a, b, c, d)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b, c, d) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d0 :: Nat). Unbundled dom d0 (a, b, c, d) -> DSignal dom d0 (a, b, c, d)

unbundle :: forall (dom :: Domain) (d0 :: Nat). DSignal dom d0 (a, b, c, d) -> Unbundled dom d0 (a, b, c, d)

Bundle (a, b, c, d, e)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b, c, d, e) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d0 :: Nat). Unbundled dom d0 (a, b, c, d, e) -> DSignal dom d0 (a, b, c, d, e)

unbundle :: forall (dom :: Domain) (d0 :: Nat). DSignal dom d0 (a, b, c, d, e) -> Unbundled dom d0 (a, b, c, d, e)

Bundle (a, b, c, d, e, f)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b, c, d, e, f) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d0 :: Nat). Unbundled dom d0 (a, b, c, d, e, f) -> DSignal dom d0 (a, b, c, d, e, f)

unbundle :: forall (dom :: Domain) (d0 :: Nat). DSignal dom d0 (a, b, c, d, e, f) -> Unbundled dom d0 (a, b, c, d, e, f)

Bundle (a, b, c, d, e, f, g)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b, c, d, e, f, g) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d0 :: Nat). Unbundled dom d0 (a, b, c, d, e, f, g) -> DSignal dom d0 (a, b, c, d, e, f, g)

unbundle :: forall (dom :: Domain) (d0 :: Nat). DSignal dom d0 (a, b, c, d, e, f, g) -> Unbundled dom d0 (a, b, c, d, e, f, g)

Bundle (a, b, c, d, e, f, g, h)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

type Unbundled dom d (a, b, c, d, e, f, g, h) = (res :: Type)

Methods

bundle :: forall (dom :: Domain) (d0 :: Nat). Unbundled dom d0 (a, b, c, d, e, f, g, h) -> DSignal dom d0 (a, b, c, d, e, f, g, h)

unbundle :: forall (dom :: Domain) (d0 :: Nat). DSignal dom d0 (a, b, c, d, e, f, g, h) -> Unbundled dom d0 (a, b, c, d, e, f, g, h)

type family Unbundled (dom :: Domain) (d :: Nat) a = res | res -> dom d a

Instances

type Unbundled dom d Bit

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d Bit = DSignal dom d Bit

type Unbundled dom d Double

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d Double = DSignal dom d Double

type Unbundled dom d Float

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d Float = DSignal dom d Float

type Unbundled dom d Int

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d Int = DSignal dom d Int

type Unbundled dom d Integer

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d Integer = DSignal dom d Integer

type Unbundled dom d Bool

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d Bool = DSignal dom d Bool

type Unbundled dom d ()

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d () = DSignal dom d ()

type Unbundled dom d (Unsigned n)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Unsigned n) = DSignal dom d (Unsigned n)

type Unbundled dom d (Signed n)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Signed n) = DSignal dom d (Signed n)

type Unbundled dom d (Index n)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Index n) = DSignal dom d (Index n)

type Unbundled dom d (BitVector n)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (BitVector n) = DSignal dom d (BitVector n)

type Unbundled dom d (Maybe a)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Maybe a) = DSignal dom d (Maybe a)

type Unbundled t delay (RTree d a)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (RTree d a) = RTree d (DSignal t delay a)

type Unbundled t d (Vec n a)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t d (Vec n a) = Vec n (DSignal t d a)

type Unbundled t delay (a, b)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b) = (DSignal t delay a, DSignal t delay b)

type Unbundled dom d (Either a b)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Either a b) = DSignal dom d (Either a b)

type Unbundled t delay (a, b, c)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b, c) = (DSignal t delay a, DSignal t delay b, DSignal t delay c)

type Unbundled dom d (Fixed rep int frac)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d (Fixed rep int frac) = DSignal dom d (Fixed rep int frac)

type Unbundled t delay (a, b, c, d)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b, c, d) = (DSignal t delay a, DSignal t delay b, DSignal t delay c, DSignal t delay d)

type Unbundled t delay (a, b, c, d, e)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b, c, d, e) = (DSignal t delay a, DSignal t delay b, DSignal t delay c, DSignal t delay d, DSignal t delay e)

type Unbundled t delay (a, b, c, d, e, f)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b, c, d, e, f) = (DSignal t delay a, DSignal t delay b, DSignal t delay c, DSignal t delay d, DSignal t delay e, DSignal t delay f)

type Unbundled t delay (a, b, c, d, e, f, g)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b, c, d, e, f, g) = (DSignal t delay a, DSignal t delay b, DSignal t delay c, DSignal t delay d, DSignal t delay e, DSignal t delay f, DSignal t delay g)

type Unbundled t delay (a, b, c, d, e, f, g, h)

Defined in Clash.Signal.Delayed.Bundle

type Unbundled t delay (a, b, c, d, e, f, g, h) = (DSignal t delay a, DSignal t delay b, DSignal t delay c, DSignal t delay d, DSignal t delay e, DSignal t delay f, DSignal t delay g, DSignal t delay h)

bundle :: Bundle a => Unbundled dom d a -> DSignal dom d a

Example:

bundle :: (DSignal dom d a, DSignal dom d b) -> DSignal clk d (a,b)

However:

bundle :: DSignal dom Bit -> DSignal dom Bit

unbundle :: Bundle a => DSignal dom d a -> Unbundled dom d a

Example:

unbundle :: DSignal dom d (a,b) -> (DSignal dom d a, DSignal dom d b)

However:

unbundle :: DSignal dom Bit -> DSignal dom Bit