FRP.Rhine.Schedule

The schedule type

data Schedule m cl1 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.

Constructors

TimeDomainOf cl1 ~ TimeDomainOf cl2 => Schedule

Fields

• startSchedule :: cl1 -> cl2 -> m (MSF m () (TimeDomainOf cl1, Either (Tag cl1) (Tag cl2)), TimeDomainOf cl1)

Utilities to create new schedules from existing ones

hoistSchedule :: (Monad m1, Monad m2) => (forall a. m1 a -> m2 a) -> Schedule m1 cl1 cl2 -> Schedule m2 cl1 cl2

Lift a schedule along a monad morphism.

flipSchedule :: Monad m => Schedule m cl1 cl2 -> Schedule m cl2 cl1

Swaps the clocks for a given schedule.

Composite clocks

data SequentialClock m cl1 cl2

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

Constructors

(TimeDomainOf cl1 ~ TimeDomainOf cl2) => SequentialClock

Fields

• sequentialCl1 :: cl1
• sequentialCl2 :: cl2
• sequentialSchedule :: Schedule m cl1 cl2

Instances

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

Associated Types

type TimeDomainOf (SequentialClock m cl1 cl2) :: *

type Tag (SequentialClock m cl1 cl2) :: *

Methods

startClock :: SequentialClock m cl1 cl2 -> m (MSF m () (TimeDomainOf (SequentialClock m cl1 cl2), Tag (SequentialClock m cl1 cl2)), TimeDomainOf (SequentialClock m cl1 cl2))

type TimeDomainOf (SequentialClock m cl1 cl2)

type TimeDomainOf (SequentialClock m cl1 cl2) = TimeDomainOf cl1

type Tag (SequentialClock m cl1 cl2)

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

data ParallelClock m cl1 cl2

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

Constructors

(TimeDomainOf cl1 ~ TimeDomainOf cl2) => ParallelClock

Fields

• parallelCl1 :: cl1
• parallelCl2 :: cl2
• parallelSchedule :: Schedule m cl1 cl2

Instances

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

Associated Types

type TimeDomainOf (ParallelClock m cl1 cl2) :: *

type Tag (ParallelClock m cl1 cl2) :: *

Methods

startClock :: ParallelClock m cl1 cl2 -> m (MSF m () (TimeDomainOf (ParallelClock m cl1 cl2), Tag (ParallelClock m cl1 cl2)), TimeDomainOf (ParallelClock m cl1 cl2))

type TimeDomainOf (ParallelClock m cl1 cl2)

type TimeDomainOf (ParallelClock m cl1 cl2) = TimeDomainOf cl1

type Tag (ParallelClock m cl1 cl2)

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

Navigating the clock tree

type family Leftmost cl where ...

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

Equations

Leftmost (SequentialClock m cl1 cl2) = Leftmost cl1

Leftmost (ParallelClock m cl1 cl2) = ParallelClock m (Leftmost cl1) (Leftmost cl2)

Leftmost cl = cl

type family Rightmost cl where ...

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

Equations

Rightmost (SequentialClock m cl1 cl2) = Rightmost cl2

Rightmost (ParallelClock m cl1 cl2) = ParallelClock m (Rightmost cl1) (Rightmost cl2)

Rightmost 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 m cl1 cl2)

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

LeafLastTime :: TimeDomainOf 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 m clL clR) cl -> ParClockInclusion clL cl

ParClockInR :: ParClockInclusion (ParallelClock m 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.