FRP.Rhine.Type

The type of a complete Rhine program: A signal network together with a matching clock value.

Documentation

data Rhine m cl a b

A Rhine consists of a SN together with a clock of matching type cl.

It is a reactive program, possibly with open inputs and outputs. If the input and output types a and b are both (), that is, the Rhine is "closed", then it is a standalone reactive program that can be run with the function flow.

Otherwise, one can start the clock and the signal network jointly as a monadic stream function, using eraseClock.

Constructors

Rhine

Fields

• sn :: SN m cl a b
• clock :: cl

Instances

GetClockProxy cl => ToClockProxy (Rhine m cl a b)

Defined in FRP.Rhine.Type

Associated Types

type Cl (Rhine m cl a b)

Methods

toClockProxy :: Rhine m cl a b -> ClockProxy (Cl (Rhine m cl a b))

type Cl (Rhine m cl a b)

Defined in FRP.Rhine.Type

type Cl (Rhine m cl a b) = cl

eraseClock :: (Monad m, Clock m cl, GetClockProxy cl) => Rhine m cl a b -> m (MSF m a (Maybe b))

Start the clock and the signal network, effectively hiding the clock type from the outside.

Since the caller will not know when the clock In cl ticks, the input a has to be given at all times, even those when it doesn't tick.

feedbackRhine :: (Clock m (In cl), Clock m (Out cl), Time (In cl) ~ Time cl, Time (Out cl) ~ Time cl) => ResamplingBuffer m (Out cl) (In cl) d c -> Rhine m cl (a, c) (b, d) -> Rhine m cl a b

Loop back data from the output to the input.

Since output and input will generally tick at different clocks, the data needs to be resampled.