FRP.Rhine.Schedule

The MonadSchedule class from the monad-schedule package is the compatibility mechanism between two different clocks. It implements a concurrency abstraction that allows the clocks to run at the same time, independently. Several such clocks running together form composite clocks, such as ParallelClock and SequentialClock. This module defines these composite clocks, and utilities to work with them.

Scheduling

scheduleList :: (Monad m, MonadSchedule m) => NonEmpty (MSF m a b) -> MSF m a (NonEmpty b)

runningSchedule :: (Monad m, MonadSchedule m, Clock m cl1, Clock m cl2, Time cl1 ~ Time cl2) => cl1 -> cl2 -> RunningClock m (Time cl1) (Tag cl1) -> RunningClock m (Time cl2) (Tag cl2) -> RunningClock m (Time cl1) (Either (Tag cl1) (Tag cl2))

Two clocks in the ScheduleT monad transformer can always be canonically scheduled. Indeed, this is the purpose for which ScheduleT was defined.

initSchedule :: (Time cl1 ~ Time cl2, Monad m, MonadSchedule m, Clock m cl1, Clock m cl2) => cl1 -> cl2 -> RunningClockInit m (Time cl1) (Either (Tag cl1) (Tag cl2))

A schedule implements a combination of two clocks. It outputs a time stamp and an Either value, which specifies which of the two subclocks has ticked.

Composite clocks

Sequentially combined clocks

data SequentialClock cl1 cl2

Two clocks can be combined with a schedule as a clock for an asynchronous sequential composition of signal networks.

Constructors

Time cl1 ~ Time cl2 => SequentialClock

Fields

• sequentialCl1 :: cl1
• sequentialCl2 :: cl2

Instances

(Monad m, MonadSchedule m, Clock m cl1, Clock m cl2) => Clock m (SequentialClock cl1 cl2)

Defined in FRP.Rhine.Schedule

Associated Types

type Time (SequentialClock cl1 cl2)

type Tag (SequentialClock cl1 cl2)

Methods

initClock :: SequentialClock cl1 cl2 -> RunningClockInit m (Time (SequentialClock cl1 cl2)) (Tag (SequentialClock cl1 cl2))

(GetClockProxy cl1, GetClockProxy cl2) => GetClockProxy (SequentialClock cl1 cl2)

Defined in FRP.Rhine.Clock.Proxy

Methods

getClockProxy :: ClockProxy (SequentialClock cl1 cl2)

type Tag (SequentialClock cl1 cl2)

Defined in FRP.Rhine.Schedule

type Tag (SequentialClock cl1 cl2) = Either (Tag cl1) (Tag cl2)

type Time (SequentialClock cl1 cl2)

Defined in FRP.Rhine.Schedule

type Time (SequentialClock cl1 cl2) = Time cl1

type SeqClock cl1 cl2 = SequentialClock cl1 cl2

Abbrevation synonym.

Parallelly combined clocks

data ParallelClock cl1 cl2

Two clocks can be combined with a schedule as a clock for an asynchronous parallel composition of signal networks.

Constructors

Time cl1 ~ Time cl2 => ParallelClock

Fields

• parallelCl1 :: cl1
• parallelCl2 :: cl2

Instances

(Monad m, MonadSchedule m, Clock m cl1, Clock m cl2) => Clock m (ParallelClock cl1 cl2)

Defined in FRP.Rhine.Schedule

Associated Types

type Time (ParallelClock cl1 cl2)

type Tag (ParallelClock cl1 cl2)

Methods

initClock :: ParallelClock cl1 cl2 -> RunningClockInit m (Time (ParallelClock cl1 cl2)) (Tag (ParallelClock cl1 cl2))

(GetClockProxy cl1, GetClockProxy cl2) => GetClockProxy (ParallelClock cl1 cl2)

Defined in FRP.Rhine.Clock.Proxy

Methods

getClockProxy :: ClockProxy (ParallelClock cl1 cl2)

type Tag (ParallelClock cl1 cl2)

Defined in FRP.Rhine.Schedule

type Tag (ParallelClock cl1 cl2) = Either (Tag cl1) (Tag cl2)

type Time (ParallelClock cl1 cl2)

Defined in FRP.Rhine.Schedule

type Time (ParallelClock cl1 cl2) = Time cl1

type ParClock cl1 cl2 = ParallelClock cl1 cl2

Abbrevation synonym.

Navigating the clock tree

type family In cl where ...

The clock that represents the rate at which data enters the system.

Equations

In (SequentialClock cl1 cl2) = In cl1

In (ParallelClock cl1 cl2) = ParallelClock (In cl1) (In cl2)

In cl = cl

type family Out cl where ...

The clock that represents the rate at which data leaves the system.

Equations

Out (SequentialClock cl1 cl2) = Out cl2

Out (ParallelClock cl1 cl2) = ParallelClock (Out cl1) (Out cl2)

Out cl = cl

data LastTime cl where

A tree representing possible last times to which the constituents of a clock may have ticked.

Constructors

SequentialLastTime :: LastTime cl1 -> LastTime cl2 -> LastTime (SequentialClock cl1 cl2)

ParallelLastTime :: LastTime cl1 -> LastTime cl2 -> LastTime (ParallelClock cl1 cl2)

LeafLastTime :: Time cl -> LastTime cl

data ParClockInclusion clS cl where

An inclusion of a clock into a tree of parallel compositions of clocks.

Constructors

ParClockInL :: ParClockInclusion (ParallelClock clL clR) cl -> ParClockInclusion clL cl

ParClockInR :: ParClockInclusion (ParallelClock clL clR) cl -> ParClockInclusion clR cl

ParClockRefl :: ParClockInclusion cl cl

parClockTagInclusion :: ParClockInclusion clS cl -> Tag clS -> Tag cl

Generates a tag for the composite clock from a tag of a leaf clock, given a parallel clock inclusion.