Clash.Signal.Bundle

The Product/Signal isomorphism

Documentation

class Bundle a where

Isomorphism between a Signal of a product type (e.g. a tuple) and a product type of Signal's.

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' clk D = Signal' clk D
  bundle   _ s = s
  unbundle _ s = s

Associated Types

type Unbundled (domain :: Domain) a = res | res -> domain a

Methods

bundle :: Unbundled domain a -> Signal domain a

Example:

bundle :: (Signal domain a, Signal domain b) -> Signal clk (a,b)

However:

bundle :: Signal domain Bit -> Signal domain Bit

bundle :: Signal domain a ~ Unbundled domain a => Unbundled domain a -> Signal domain a

Example:

bundle :: (Signal domain a, Signal domain b) -> Signal clk (a,b)

However:

bundle :: Signal domain Bit -> Signal domain Bit

unbundle :: Signal domain a -> Unbundled domain a

Example:

unbundle :: Signal domain (a,b) -> (Signal domain a, Signal domain b)

However:

unbundle :: Signal domain Bit -> Signal domain Bit

unbundle :: Unbundled domain a ~ Signal domain a => Signal domain a -> Unbundled domain a

Example:

unbundle :: Signal domain (a,b) -> (Signal domain a, Signal domain b)

However:

unbundle :: Signal domain Bit -> Signal domain Bit

Instances

Bundle Bool

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain Bool = (res :: *)

Methods

bundle :: Unbundled domain Bool -> Signal domain Bool

unbundle :: Signal domain Bool -> Unbundled domain Bool

Bundle Double

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain Double = (res :: *)

Methods

bundle :: Unbundled domain Double -> Signal domain Double

unbundle :: Signal domain Double -> Unbundled domain Double

Bundle Float

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain Float = (res :: *)

Methods

bundle :: Unbundled domain Float -> Signal domain Float

unbundle :: Signal domain Float -> Unbundled domain Float

Bundle Int

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain Int = (res :: *)

Methods

bundle :: Unbundled domain Int -> Signal domain Int

unbundle :: Signal domain Int -> Unbundled domain Int

Bundle Integer

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain Integer = (res :: *)

Methods

bundle :: Unbundled domain Integer -> Signal domain Integer

unbundle :: Signal domain Integer -> Unbundled domain Integer

Bundle ()

Note that:

bundle   :: () -> Signal domain ()
unbundle :: Signal domain () -> ()

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain () = (res :: *)

Methods

bundle :: Unbundled domain () -> Signal domain ()

unbundle :: Signal domain () -> Unbundled domain ()

Bundle Bit

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain Bit = (res :: *)

Methods

bundle :: Unbundled domain Bit -> Signal domain Bit

unbundle :: Signal domain Bit -> Unbundled domain Bit

Bundle (Maybe a)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Maybe a) = (res :: *)

Methods

bundle :: Unbundled domain (Maybe a) -> Signal domain (Maybe a)

unbundle :: Signal domain (Maybe a) -> Unbundled domain (Maybe a)

Bundle (BitVector n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (BitVector n) = (res :: *)

Methods

bundle :: Unbundled domain (BitVector n) -> Signal domain (BitVector n)

unbundle :: Signal domain (BitVector n) -> Unbundled domain (BitVector n)

Bundle (Index n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Index n) = (res :: *)

Methods

bundle :: Unbundled domain (Index n) -> Signal domain (Index n)

unbundle :: Signal domain (Index n) -> Unbundled domain (Index n)

Bundle (Unsigned n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Unsigned n) = (res :: *)

Methods

bundle :: Unbundled domain (Unsigned n) -> Signal domain (Unsigned n)

unbundle :: Signal domain (Unsigned n) -> Unbundled domain (Unsigned n)

Bundle (Signed n)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Signed n) = (res :: *)

Methods

bundle :: Unbundled domain (Signed n) -> Signal domain (Signed n)

unbundle :: Signal domain (Signed n) -> Unbundled domain (Signed n)

Bundle (Either a b)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Either a b) = (res :: *)

Methods

bundle :: Unbundled domain (Either a b) -> Signal domain (Either a b)

unbundle :: Signal domain (Either a b) -> Unbundled domain (Either a b)

Bundle (a, b)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (a, b) = (res :: *)

Methods

bundle :: Unbundled domain (a, b) -> Signal domain (a, b)

unbundle :: Signal domain (a, b) -> Unbundled domain (a, b)

KnownNat n => Bundle (Vec n a)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Vec n a) = (res :: *)

Methods

bundle :: Unbundled domain (Vec n a) -> Signal domain (Vec n a)

unbundle :: Signal domain (Vec n a) -> Unbundled domain (Vec n a)

KnownNat d => Bundle (RTree d a)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (RTree d a) = (res :: *)

Methods

bundle :: Unbundled domain (RTree d a) -> Signal domain (RTree d a)

unbundle :: Signal domain (RTree d a) -> Unbundled domain (RTree d a)

Bundle (a, b, c)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (a, b, c) = (res :: *)

Methods

bundle :: Unbundled domain (a, b, c) -> Signal domain (a, b, c)

unbundle :: Signal domain (a, b, c) -> Unbundled domain (a, b, c)

Bundle (Fixed rep int frac)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (Fixed rep int frac) = (res :: *)

Methods

bundle :: Unbundled domain (Fixed rep int frac) -> Signal domain (Fixed rep int frac)

unbundle :: Signal domain (Fixed rep int frac) -> Unbundled domain (Fixed rep int frac)

Bundle (a, b, c, d)

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (a, b, c, d) = (res :: *)

Methods

bundle :: Unbundled domain (a, b, c, d) -> Signal domain (a, b, c, d)

unbundle :: Signal domain (a, b, c, d) -> Unbundled domain (a, b, c, d)

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

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (a, b, c, d, e) = (res :: *)

Methods

bundle :: Unbundled domain (a, b, c, d, e) -> Signal domain (a, b, c, d, e)

unbundle :: Signal domain (a, b, c, d, e) -> Unbundled domain (a, b, c, d, e)

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

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (a, b, c, d, e, f) = (res :: *)

Methods

bundle :: Unbundled domain (a, b, c, d, e, f) -> Signal domain (a, b, c, d, e, f)

unbundle :: Signal domain (a, b, c, d, e, f) -> Unbundled domain (a, b, c, d, e, f)

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

Defined in Clash.Signal.Bundle

Associated Types

type Unbundled domain (a, b, c, d, e, f, g) = (res :: *)

Methods

bundle :: Unbundled domain (a, b, c, d, e, f, g) -> Signal domain (a, b, c, d, e, f, g)

unbundle :: Signal domain (a, b, c, d, e, f, g) -> Unbundled domain (a, b, c, d, e, f, g)

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

Defined in Clash.Signal.Bundle

Associated Types

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

Methods

bundle :: Unbundled domain (a, b, c, d, e, f, g, h) -> Signal domain (a, b, c, d, e, f, g, h)

unbundle :: Signal domain (a, b, c, d, e, f, g, h) -> Unbundled domain (a, b, c, d, e, f, g, h)