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' (clk :: Clock) a

Methods

bundle' :: SClock clk -> Unbundled' clk a -> Signal' clk a

Example:

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

However:

bundle' :: Signal' clk Bit -> Signal' clk Bit

bundle' :: SClock clk -> Signal' clk a -> Signal' clk a

Example:

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

However:

bundle' :: Signal' clk Bit -> Signal' clk Bit

unbundle' :: SClock clk -> Signal' clk a -> Unbundled' clk a

Example:

unbundle' :: Signal' clk (a,b) -> (Signal' clk a, Signal' clk b)

However:

unbundle' :: Signal' clk Bit -> Signal' clk Bit

unbundle' :: SClock clk -> Signal' clk a -> Signal' clk a

Example:

unbundle' :: Signal' clk (a,b) -> (Signal' clk a, Signal' clk b)

However:

unbundle' :: Signal' clk Bit -> Signal' clk Bit

Instances

Bundle Bool

Associated Types

type Unbundled' (clk :: Clock) Bool :: *

Methods

bundle' :: SClock clk -> Unbundled' clk Bool -> Signal' clk Bool

unbundle' :: SClock clk -> Signal' clk Bool -> Unbundled' clk Bool

Bundle Double

Associated Types

type Unbundled' (clk :: Clock) Double :: *

Methods

bundle' :: SClock clk -> Unbundled' clk Double -> Signal' clk Double

unbundle' :: SClock clk -> Signal' clk Double -> Unbundled' clk Double

Bundle Float

Associated Types

type Unbundled' (clk :: Clock) Float :: *

Methods

bundle' :: SClock clk -> Unbundled' clk Float -> Signal' clk Float

unbundle' :: SClock clk -> Signal' clk Float -> Unbundled' clk Float

Bundle Int

Associated Types

type Unbundled' (clk :: Clock) Int :: *

Methods

bundle' :: SClock clk -> Unbundled' clk Int -> Signal' clk Int

unbundle' :: SClock clk -> Signal' clk Int -> Unbundled' clk Int

Bundle Integer

Associated Types

type Unbundled' (clk :: Clock) Integer :: *

Methods

bundle' :: SClock clk -> Unbundled' clk Integer -> Signal' clk Integer

unbundle' :: SClock clk -> Signal' clk Integer -> Unbundled' clk Integer

Bundle ()

Associated Types

type Unbundled' (clk :: Clock) () :: *

Methods

bundle' :: SClock clk -> Unbundled' clk () -> Signal' clk ()

unbundle' :: SClock clk -> Signal' clk () -> Unbundled' clk ()

Bundle (Maybe a)

Associated Types

type Unbundled' (clk :: Clock) (Maybe a) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Maybe a) -> Signal' clk (Maybe a)

unbundle' :: SClock clk -> Signal' clk (Maybe a) -> Unbundled' clk (Maybe a)

Bundle (Index n)

Associated Types

type Unbundled' (clk :: Clock) (Index n) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Index n) -> Signal' clk (Index n)

unbundle' :: SClock clk -> Signal' clk (Index n) -> Unbundled' clk (Index n)

Bundle (BitVector n)

Associated Types

type Unbundled' (clk :: Clock) (BitVector n) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (BitVector n) -> Signal' clk (BitVector n)

unbundle' :: SClock clk -> Signal' clk (BitVector n) -> Unbundled' clk (BitVector n)

Bundle (Signed n)

Associated Types

type Unbundled' (clk :: Clock) (Signed n) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Signed n) -> Signal' clk (Signed n)

unbundle' :: SClock clk -> Signal' clk (Signed n) -> Unbundled' clk (Signed n)

Bundle (Unsigned n)

Associated Types

type Unbundled' (clk :: Clock) (Unsigned n) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Unsigned n) -> Signal' clk (Unsigned n)

unbundle' :: SClock clk -> Signal' clk (Unsigned n) -> Unbundled' clk (Unsigned n)

Bundle (Either a b)

Associated Types

type Unbundled' (clk :: Clock) (Either a b) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Either a b) -> Signal' clk (Either a b)

unbundle' :: SClock clk -> Signal' clk (Either a b) -> Unbundled' clk (Either a b)

Bundle (a, b)

Associated Types

type Unbundled' (clk :: Clock) (a, b) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (a, b) -> Signal' clk (a, b)

unbundle' :: SClock clk -> Signal' clk (a, b) -> Unbundled' clk (a, b)

KnownNat n => Bundle (Vec n a)

Associated Types

type Unbundled' (clk :: Clock) (Vec n a) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Vec n a) -> Signal' clk (Vec n a)

unbundle' :: SClock clk -> Signal' clk (Vec n a) -> Unbundled' clk (Vec n a)

Bundle (a, b, c)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (a, b, c) -> Signal' clk (a, b, c)

unbundle' :: SClock clk -> Signal' clk (a, b, c) -> Unbundled' clk (a, b, c)

Bundle (Fixed rep int frac)

Associated Types

type Unbundled' (clk :: Clock) (Fixed rep int frac) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (Fixed rep int frac) -> Signal' clk (Fixed rep int frac)

unbundle' :: SClock clk -> Signal' clk (Fixed rep int frac) -> Unbundled' clk (Fixed rep int frac)

Bundle (a, b, c, d)

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (a, b, c, d) -> Signal' clk (a, b, c, d)

unbundle' :: SClock clk -> Signal' clk (a, b, c, d) -> Unbundled' clk (a, b, c, d)

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

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (a, b, c, d, e) -> Signal' clk (a, b, c, d, e)

unbundle' :: SClock clk -> Signal' clk (a, b, c, d, e) -> Unbundled' clk (a, b, c, d, e)

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

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e, f) :: *

Methods

bundle' :: SClock clk -> Unbundled' clk (a, b, c, d, e, f) -> Signal' clk (a, b, c, d, e, f)

unbundle' :: SClock clk -> Signal' clk (a, b, c, d, e, f) -> Unbundled' clk (a, b, c, d, e, f)

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

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e, f, g) :: *

Methods

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

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

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

Associated Types

type Unbundled' (clk :: Clock) (a, b, c, d, e, f, g, h) :: *

Methods

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

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