FRP.Rhine.Reactimation.Tick

This module contains internals needed for the reactimation of signal functions. None of it should be relevant for a typical user of this library.

Documentation

data Tickable m cla clb cl clc cld a b c d

A signal network (SN) enclosed by matching ResamplingBuffers and further auxiliary data, such that it can be stepped with each arriving tick from a clock cl. They play a similar role like ReactHandles in dunai.

The type parameters:

• m: The monad in which the SN and the ResamplingBuffers produce side effects
• cla: The (irrelevant) input clock of the left ResamplingBuffer
• clb: The clock at which the left ResamplingBuffer produces output
• cl: The clock at which the SN ticks
• clc: The clock at which the right ResamplingBuffer accepts input
• cld: The (irrelevant) output clock of the right ResamplingBuffer
• a: The (irrelevant) input type of the left ResamplingBuffer
• b: The input type of the SN
• c: The output type of the SN
• d: The (irrelevant) output type of the right ResamplingBuffer

Constructors

Tickable

Fields

• buffer1 :: ResamplingBuffer m cla clb a b

  The left buffer from which the input is taken.

• ticksn :: SN m cl b c

  The signal network that will process the data.

• buffer2 :: ResamplingBuffer m clc cld c d

  The right buffer in which the output is stored.

• parClockIn :: ParClockInclusion (In cl) clb

  The leftmost clock of the signal network, cl, may be a parallel subclock of the buffer clock. parClockIn specifies in which position 'In cl' is a parallel subclock of clb.

• parClockOut :: ParClockInclusion (Out cl) clc

  The same on the output side.

• lastTime :: LastTime cl

  The last times when the different parts of the signal tree have ticked.

• initTime :: Time cl

  The time when the whole clock was initialised.

initLastTime :: SN m cl a b -> Time cl -> LastTime cl

Initialise the tree of last tick times.

createTickable :: ResamplingBuffer m cla (In cl) a b -> SN m cl b c -> ResamplingBuffer m (Out cl) cld c d -> Time cl -> Tickable m cla (In cl) cl (Out cl) cld a b c d

Initialise a Tickable from a signal network, two matching enclosing resampling buffers and an initial time.

tick

Arguments

:: (Monad m, Clock m cl, Time cla ~ Time cl, Time clb ~ Time cl, Time clc ~ Time cl, Time cld ~ Time cl, Time (In cl) ~ Time cl, Time (Out cl) ~ Time cl)

=> Tickable m cla clb cl clc cld a b c d

-> Time cl

Timestamp of the present tick

-> Tag cl

Tag of the overall clock; contains the information which subsystem will become active

-> m (Tickable m cla clb cl clc cld a b c d)

In this function, one tick, or step of an asynchronous signal network happens. The TimeInfo holds the information which part of the signal tree will tick. This information is encoded in the Tag of the TimeInfo, which is of type 'Either tag1 tag2' in case of a SequentialClock or a ParallelClock, encoding either a tick for the left clock or the right clock.

trivialResamplingBuffer :: Monad m => cl -> ResamplingBuffer m (Out cl) (In cl) () ()

A ResamplingBuffer producing only units. (Slightly more efficient and direct implementation than the one in Timeless that additionally unifies the clock types in a way needed for the tick implementation.)