Clash.Signal.Delayed.Bundle

Documentation

class Bundle a where

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

Minimal complete definition

Nothing

Associated Types

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

Methods

bundle :: 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

bundle :: DSignal dom d a ~ Unbundled dom d 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 :: 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

unbundle :: Unbundled dom d a ~ DSignal dom d 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

Instances

Bundle Bool

Defined in Clash.Signal.Delayed.Bundle

Associated Types

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

Methods

bundle :: Unbundled dom d Bool -> DSignal dom d Bool

unbundle :: 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 :: Unbundled dom d Double -> DSignal dom d Double

unbundle :: 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 :: Unbundled dom d Float -> DSignal dom d Float

unbundle :: 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 :: Unbundled dom d Int -> DSignal dom d Int

unbundle :: 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 :: Unbundled dom d Integer -> DSignal dom d Integer

unbundle :: 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 :: Unbundled dom d () -> DSignal dom d ()

unbundle :: 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 :: Unbundled dom d Bit -> DSignal dom d Bit

unbundle :: DSignal dom d Bit -> Unbundled dom d Bit

Bundle EmptyTuple

See https://github.com/clash-lang/clash-compiler/pull/539/commits/94b0bff5770aa4961e04ddce2515130df3fc7863 and documentation for TaggedEmptyTuple.

Defined in Clash.Signal.Delayed.Bundle

Associated Types

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

Methods

bundle :: Unbundled dom d EmptyTuple -> DSignal dom d EmptyTuple

unbundle :: DSignal dom d EmptyTuple -> Unbundled dom d EmptyTuple

Bundle (Maybe a)

Defined in Clash.Signal.Delayed.Bundle

Associated Types

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

Methods

bundle :: Unbundled dom d (Maybe a) -> DSignal dom d (Maybe a)

unbundle :: 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 :: Unbundled dom d (BitVector n) -> DSignal dom d (BitVector n)

unbundle :: 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 :: Unbundled dom d (Index n) -> DSignal dom d (Index n)

unbundle :: 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 :: Unbundled dom d (Unsigned n) -> DSignal dom d (Unsigned n)

unbundle :: 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 :: Unbundled dom d (Signed n) -> DSignal dom d (Signed n)

unbundle :: 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 :: Unbundled dom d (Either a b) -> DSignal dom d (Either a b)

unbundle :: 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 :: Unbundled dom d (a, b) -> DSignal dom d (a, b)

unbundle :: 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 :: Unbundled dom d (Vec n a) -> DSignal dom d (Vec n a)

unbundle :: 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 :: Unbundled dom d0 (RTree d a) -> DSignal dom d0 (RTree d a)

unbundle :: 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 :: Unbundled dom d (a, b, c) -> DSignal dom d (a, b, c)

unbundle :: 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 :: Unbundled dom d (Fixed rep int frac) -> DSignal dom d (Fixed rep int frac)

unbundle :: 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 :: Unbundled dom d0 (a, b, c, d) -> DSignal dom d0 (a, b, c, d)

unbundle :: 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 :: Unbundled dom d0 (a, b, c, d, e) -> DSignal dom d0 (a, b, c, d, e)

unbundle :: 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 :: Unbundled dom d0 (a, b, c, d, e, f) -> DSignal dom d0 (a, b, c, d, e, f)

unbundle :: 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 :: Unbundled dom d0 (a, b, c, d, e, f, g) -> DSignal dom d0 (a, b, c, d, e, f, g)

unbundle :: 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 :: Unbundled dom d0 (a, b, c, d, e, f, g, h) -> DSignal dom d0 (a, b, c, d, e, f, g, h)

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

Tools to emulate pre Clash 1.0 Bundle () instance

data EmptyTuple

See TaggedEmptyTuple

Constructors

EmptyTuple

Instances

Bundle EmptyTuple

See https://github.com/clash-lang/clash-compiler/pull/539/commits/94b0bff5770aa4961e04ddce2515130df3fc7863 and documentation for TaggedEmptyTuple.

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled dom EmptyTuple = (res :: Type)

Methods

bundle :: Unbundled dom EmptyTuple -> Signal dom EmptyTuple

unbundle :: Signal dom EmptyTuple -> Unbundled dom EmptyTuple

Bundle EmptyTuple

See https://github.com/clash-lang/clash-compiler/pull/539/commits/94b0bff5770aa4961e04ddce2515130df3fc7863 and documentation for TaggedEmptyTuple.

Defined in Clash.Signal.Delayed.Bundle

Associated Types

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

Methods

bundle :: Unbundled dom d EmptyTuple -> DSignal dom d EmptyTuple

unbundle :: DSignal dom d EmptyTuple -> Unbundled dom d EmptyTuple

type Unbundled dom EmptyTuple

Defined in Clash.Signal.Bundle

type Unbundled dom EmptyTuple = TaggedEmptyTuple dom

type Unbundled dom d EmptyTuple

Defined in Clash.Signal.Delayed.Bundle

type Unbundled dom d EmptyTuple = TaggedEmptyTuple dom d

data TaggedEmptyTuple (dom :: Domain) (d :: Nat)

Same as Clash.Signal.Bundle.TaggedEmptyTuple, but adapted for DSignal.

Constructors

TaggedEmptyTuple