elerea-0.6.0: A minimalistic FRP library



Elerea (Eventless Reactivity) is a simplistic FRP implementation that parts with the concept of events, and uses a continuous latching construct instead. The user sees the functionality through an applicative interface, which is used to build up a network of interconnected mutable references. The network is executed iteratively, where each superstep consists of two phases: sampling-aging and finalisation. As an example, the following code is a possible way to define an approximation of our beloved trig functions:

 sine = integral 0 cosine
 cosine = integral 1 (-sine)

Note that integral is not a primitive, it can be defined by the user as a transfer function. A possible implementation that can be used on any Fractional signal looks like this:

 integral x0 s = transfer x0 (\dt x x0 -> x0+x*realToFrac dt) s

Head to FRP.Elerea.Internal for the implementation details. To get a general idea how to use the library, check out the sources in the elerea-examples package.



type DTime = DoubleSource

Time is continuous. Nothing fancy.

type Sink a = a -> IO ()Source

Sinks are used when feeding input into peripheral-bound signals.

data Signal a Source

A signal is represented as a transactional structural node.


Functor Signal 
Applicative Signal

The Applicative instance with run-time optimisation. The <*> operator tries to move all the pure parts to its left side in order to flatten the structure, hence cutting down on book-keeping costs. Since applicatives are used with pure functions and lifted values most of the time, one can gain a lot by merging these nodes.

Eq (Signal a)

The equality test checks whether two signals are physically the same.

Floating t => Floating (Signal t) 
Fractional t => Fractional (Signal t) 
Num t => Num (Signal t) 
Show (Signal a)

The Show instance is only defined for the sake of Num...

data StartToken Source

An empty type to use as a token for injecting data dependencies.



:: Signal a

the top-level signal

-> DTime

the amount of time to advance

-> IO a

the current value of the signal

Advancing the whole network that the given signal depends on by the amount of time given in the second argument.



:: a

initial value

-> IO (Signal a, Sink a)

the signal and an IO function to feed it

A signal that can be directly fed through the sink function returned. This can be used to attach the network to the outer world.



:: Signal a

the actual output

-> Signal t

a signal guaranteed to age when this one is sampled

-> Signal a 

Dependency injection to allow aging signals whose output is not necessarily needed to produce the current sample of the first argument. It's equivalent to (flip . liftA2 . flip) const, as it evaluates its second argument first.

(.@.) :: Signal a -> Signal t -> Signal aSource

A short alternative name for keepAlive.



:: a

initial state

-> (DTime -> a -> a)

state transformation

-> Signal a 

A pure stateful signal. The initial state is the first output.



:: a

initial internal state

-> (DTime -> t -> a -> a)

state updater function

-> Signal t

input signal

-> Signal a 

A stateful transfer function. The current input affects the current output, i.e. the initial state given in the first argument is considered to appear before the first output, and can only be directly observed by the sampleDelayed function.



:: Signal a

s: initial behaviour

-> Signal Bool

e: latch control signal

-> Signal (Signal a)

ss: signal of potential future behaviours

-> Signal a 

Reactive signal that starts out as s and can change its behaviour to the one supplied in ss whenever e is true. The change can be observed immediately, unless the signal is sampled by sampleDelayed, which puts a delay on the latch control (but not on the latched signal!).



:: a

initial output

-> Signal a

the signal to delay

-> Signal a 

The delay transfer function emits the value of a signal from the previous superstep, starting with the filler value given in the first argument. It has to be a primitive, otherwise it could not be used to prevent automatic delays.

startTokens :: Signal StartTokenSource

A stream of tokens freshly generated in each superstep. These are dummy values that must not be evaluated (they are in fact undefined), but distributed among signals that need to be constructed at the given moment in the absence of other dependencies on current values, so as to prevent let-floating from moving otherwise independent signals to an outer scope. Dependency on these tokens can be established with the ==> operator.

(==>) :: StartToken -> a -> aSource

An operator that ignores its first argument and returns the second, but hides the fact that the first argument is not needed. It is equivalent to flip const, but it cannot be inlined.

edge :: Signal Bool -> Signal BoolSource

The edge transfer function takes a bool signal and emits another bool signal that turns true only at the moment when there is a rising edge on the input.

(==@) :: Eq a => Signal a -> Signal a -> Signal BoolSource

Point-wise equality of two signals.

(/=@) :: Eq a => Signal a -> Signal a -> Signal BoolSource

Point-wise inequality of two signals.

(<@) :: Ord a => Signal a -> Signal a -> Signal BoolSource

Point-wise comparison of two signals.

(<=@) :: Ord a => Signal a -> Signal a -> Signal BoolSource

Point-wise comparison of two signals.

(>=@) :: Ord a => Signal a -> Signal a -> Signal BoolSource

Point-wise comparison of two signals.

(>@) :: Ord a => Signal a -> Signal a -> Signal BoolSource

Point-wise comparison of two signals.

(&&@) :: Signal Bool -> Signal Bool -> Signal BoolSource

Point-wise AND of two boolean signals.

(||@) :: Signal Bool -> Signal Bool -> Signal BoolSource

Point-wise OR of two boolean signals.