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 = res | res -> clk

Methods

bundle :: 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 :: 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 :: 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 :: 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 = (res :: *)

Methods

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

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

Bundle Double

Associated Types

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

Methods

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

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

Bundle Float

Associated Types

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

Methods

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

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

Bundle Int

Associated Types

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

Methods

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

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

Bundle Integer

Associated Types

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

Methods

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

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

Bundle ()

Note that:

bundle   :: () -> Signal' clk ()
unbundle :: Signal' clk () -> ()

Associated Types

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

Methods

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

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

Bundle (Maybe a)

Associated Types

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

Methods

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

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

Bundle (Index n)

Associated Types

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

Methods

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

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

Bundle (BitVector n)

Associated Types

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

Methods

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

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

Bundle (Signed n)

Associated Types

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

Methods

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

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

Bundle (Unsigned n)

Associated Types

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

Methods

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

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

Bundle (Either a b)

Associated Types

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

Methods

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

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

Bundle (a, b)

Associated Types

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

Methods

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

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

KnownNat n => Bundle (Vec n a)

Associated Types

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

Methods

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

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

KnownNat d => Bundle (RTree d a)

Associated Types

type Unbundled' (clk :: Clock) (RTree d a) = (res :: *)

Methods

bundle :: Unbundled' clk (RTree d a) -> Signal' clk (RTree d a)

unbundle :: Signal' clk (RTree d a) -> Unbundled' clk (RTree d a)

Bundle (a, b, c)

Associated Types

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

Methods

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

unbundle :: 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) = (res :: *)

Methods

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

unbundle :: 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) = (res :: *)

Methods

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

unbundle :: 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) = (res :: *)

Methods

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

unbundle :: 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) = (res :: *)

Methods

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

unbundle :: 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) = (res :: *)

Methods

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

unbundle :: 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) = (res :: *)

Methods

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

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