CLaSH.Signal.Delayed.Explicit

Delay-annotated synchronous signals

data DSignal' clk delay a

A synchronized signal with samples of type a, synchronized to clock clk, that has accumulated delay amount of samples delay along its path.

Instances

Functor (DSignal' clk delay)

Applicative (DSignal' clk delay)

Foldable (DSignal' clk delay)

Traversable (DSignal' clk delay)

Bounded a => Bounded (DSignal' clk delay a)

Enum a => Enum (DSignal' clk delay a)

Eq (DSignal' clk delay a)

Fractional a => Fractional (DSignal' clk delay a)

Integral a => Integral (DSignal' clk delay a)

Num a => Num (DSignal' clk delay a)

Ord a => Ord (DSignal' clk delay a)

(Num a, Ord a) => Real (DSignal' clk delay a)

Show a => Show (DSignal' clk delay a)

Arbitrary a => Arbitrary (DSignal' clk delay a)

CoArbitrary a => CoArbitrary (DSignal' clk delay a)

Bits a => Bits (DSignal' clk delay a)

FiniteBits a => FiniteBits (DSignal' clk delay a)

Default a => Default (DSignal' clk delay a)

Lift a => Lift (DSignal' clk delay a)

SaturatingNum a => SaturatingNum (DSignal' clk delay a)

ExtendingNum a b => ExtendingNum (DSignal' clk n a) (DSignal' clk n b)

type AResult (DSignal' clk n a) (DSignal' clk n b) = DSignal' clk n (AResult a b)

type MResult (DSignal' clk n a) (DSignal' clk n b) = DSignal' clk n (MResult a b)

delay' :: forall clk a n d. KnownNat d => SClock clk -> Vec d a -> DSignal' clk n a -> DSignal' clk (n + d) a

Delay a DSignal' for d periods.

delay3 :: DSignal' clk n Int -> DSignal' clk (n + 3) Int
delay3 = delay (0 :> 0 :> 0 :> Nil)

>>> sampleN 6 (delay3 (dfromList [1..]))
[0,0,0,1,2,3]

delayI' :: (Default a, KnownNat d) => SClock clk -> DSignal' clk n a -> DSignal' clk (n + d) a

Delay a DSignal clk' for m periods, where m is derived from the context.

delay2 :: DSignal' clk n Int -> DSignal' clk (n + 2) Int
delay2 = delayI

>>> sampleN 6 (delay2 (dfromList [1..]))
[0,0,1,2,3,4]

feedback :: (DSignal' clk n a -> (DSignal' clk n a, DSignal' clk ((n + m) + 1) a)) -> DSignal' clk n a

Feed the delayed result of a function back to its input:

mac :: DSignal' clk 0 Int -> DSignal' clk 0 Int -> DSignal' clk 0 Int
mac x y = feedback (mac' x y)
  where
    mac' :: DSignal' clk 0 Int -> DSignal' clk 0 Int -> DSignal' clk 0 Int
         -> (DSignal' clk 0 Int, DSignal' clk 1 Int)
    mac' a b acc = let acc' = a * b + acc
                   in  (acc, delay (singleton 0) acc')

>>> sampleN 6 (mac (dfromList [1..]) (dfromList [1..]))
[0,1,5,14,30,55]

Signal <-> DSignal conversion

fromSignal :: Signal' clk a -> DSignal' clk 0 a

Signals are not delayed

sample s == dsample (fromSignal s)

toSignal :: DSignal' clk delay a -> Signal' clk a

Strip a DSignal from its delay information.

List <-> DSignal conversion (not synthesisable)

dfromList :: [a] -> DSignal' clk 0 a

Create a DSignal' from a list

Every element in the list will correspond to a value of the signal for one clock cycle.

>>> sampleN 2 (dfromList [1,2,3,4,5])
[1,2]

NB: This function is not synthesisable

Experimental

unsafeFromSignal :: Signal' clk a -> DSignal' clk n a

EXPERIMENTAL

Unsafely convert a Signal to any DSignal clk'.

NB: Should only be used to interface with functions specified in terms of Signal.

antiDelay :: SNat d -> DSignal' clk (n + d) a -> DSignal' clk n a

EXPERIMENTAL

Access a delayed signal in the present.

mac :: DSignal clk' 0 Int -> DSignal clk' 0 Int -> DSignal clk' 0 Int
mac x y = acc'
  where
    acc' = (x * y) + antiDelay d1 acc
    acc  = delay (singleton 0) acc'