Library

Module

Module type

Parameter

Class

Class type

sectionYPositions = computeSectionYPositions($el), 10)" x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)">

On This Page

Legend:

Library

Module

Module type

Parameter

Class

Class type

Library

Module

Module type

Parameter

Class

Class type

Signals.

A signal is a value that varies continuously over time. Consult the `semantics`

.signalssemantics and notations

}

of signals.

`type 'a t = 'a signal`

The type for signals of type `'a`

.

`type 'a set = ?step:Step.t -> 'a -> unit`

The type for functions setting signal values of type `'a`

. See `create`

.

`log ?now s f`

is `Logr.(create ~now (const f $ obs s))`

.

`create v`

is a primitive signal set to the value `v`

and a `set`

function. The function `set`

is such that:

`set v`

sets the signal's value to`v`

at the time it is called.`set ~step v`

sets the signal value to`v`

at the time it is called and schedules an update at time`step`

.

**Warning.** `set`

must not be used in the definition of signals or events.

`val eq : 'a signal -> 'a -> 'a -> bool`

`eq s`

is `s`

's equality function.

`with_eq eq s`

is `s`

with equality function `eq`

.

`val value : 'a signal -> 'a`

`value s`

is the current value of `s`

, [`s`

]_{t}

`val rough_value : 'a signal -> 'a`

`rough_value s`

is the current value of `s`

, but in contrast to `value`

it might not be exactly [`s`

]_{t}.

`val const : ?eq:('a -> 'a -> bool) -> 'a -> 'a signal`

`const v`

is always `v`

, [`const v`

]_{t} `= v`

.

`hold i e`

has the value of `e`

's last occurrence or the value of `i`

provides the signal value at creation time if there's no event at that time.

- [
`hold i e`

]_{t}`= i`

if [`e`

]_{≤t}`= None`

- [
`hold i e`

]_{t}`= v`

if [`e`

]_{≤t}`= Some v`

`bind s f`

is the signal that results from applying `f`

to `s`

, [`bind s f`

]_{t} `=`

[f[`s`

]_{t}]_{t}.

`swap s se`

is `join (hold ~eq:( == ) s se)`

that is the values of `s`

followed by values of the last signal that occurred on `se`

.

`changes s`

occurs with the value of `s`

whenever it changes.

- [
`changes s`

]_{t}`= Some v`

if [`s`

]_{t}`= v`

and [`s`

]_{t-dt}`= v'`

and`eq v v' = false`

. - [
`changes s`

]_{t}`= None`

otherwise.

**Warning.** By definition no event occurs if `s`

changes at creation time (`0 - dt`

is undefined).

`map f s`

is `s`

transformed by `f`

, [`map f s`

]_{t} = `f`

[`s`

]_{t}.

`app sf s`

holds the value of `sf`

applied to the value of `s`

, [`app sf s`

]_{t} `=`

[`sf`

]_{t} [`s`

]_{t}.

`sample s ~on f`

samples `s`

at `e`

's occurrences.

- [
`sample s ~on f`

]_{t}`= Some (f sv ev)`

if [`on`

]_{t}`= Some ev`

and [`s`

]_{t}`= sv`

. - [
`sample s ~on f`

]_{t}`= None`

otherwise.

`sample_filter s on f`

is `E.Option.on_some (sample s ~on f)`

.

`snapshot ~on s`

is `sample (fun v _ -> v) ~on s`

.

**TODO.** Candidate for deletion.

`accum i e`

is `hold i (E.accum i e)`

.

`until ~limit ~init ~next s`

is `s`

until `next`

occurs, after which the value `s`

had just before (`limit`

is `false`

, default) or whenever `next`

occurs (`limit`

is `true`

) is kept forever.

- [
`until ~limit ~init ~next s`

]_{t}`=`

[`s`

]_{t}if [`next`

]_{≤t}`= None`

- [
`until ~limit ~init ~next s`

]_{t}`= init`

if [`next`

]_{0}`= Some _`

- [
`until ~limit:false ~init ~next s`

]_{t}`=`

[`s`

]_{t'- dt}if [`next`

]_{t'}`= Some _`

and [`next`

]_{<t'}`= None`

. - [
`until ~limit:true ~init ~next s`

]_{t}`=`

[`s`

]_{t'}if [`next`

]_{t'}`= Some _`

and [`next`

]_{<t'}`= None`

.

`init`

defaults to `value s`

.

`follow ~init s ~on`

is `s`

whenever `on`

is `true`

and the last value of `s`

when `on`

was `true`

if `on`

is `false`

. If `on`

is `false`

at creation time `init`

is used (defaults to ```
S.value
s
```

).

- [
`follow ~init s ~on`

]_{0}`=`

[`s`

]_{0}if [`on`

]_{0}`= true`

- [
`follow ~init s ~on`

]_{0}`=`

[`init`

]_{0}if [`on`

]_{0}`= false`

- [
`follow ~init s ~on`

]_{t}`=`

[`s`

]_{t}if [`on`

]_{t}`= true`

- [
`follow ~init s ~on`

]_{t}`=`

[`follow ~init s ~on`

]_{t'}if [`on`

]_{t}`= false`

where t' is the greatest t' < t with [`on`

]_{t'}`= true`

or`0`

if there is no such time.

`defer s`

is `s`

delayed by an infinitesimal amount of time. At creation time `init`

is used (defaults to `S.value s`

).

- [
`defer s`

]_{t}`=`

`init`

for t = 0. - [
`defer s`

]_{t}`=`

[`s`

]_{t-dt}otherwise.

`delay i (lazy s)`

is the value `s`

had an infinitesimal amount of time before:

- [
`delay i (lazy s)`

]_{t}`=`

`i`

for t = 0. - [
`delay i (lazy s)`

]_{t}`=`

[`s'`

]_{t-dt}otherwise.

In `fix sf`

, `sf`

is called with a signal `s`

that represents

the signal returned by `sf`

delayed by an infinitesimal amount time. If `s', r = sf s`

then `r`

is returned by `fix`

and `s`

is such that :

- [
`s`

]_{t}`=`

`i`

for t = 0. - [
`s`

]_{t}`=`

[`s'`

]_{t-dt}otherwise.

Lifting combinators. For a given `n`

the semantics is : [`ln f a1`

... `an`

]_{t} = f [`a1`

]_{t} ... [`an`

]_{t}

`module Bool : sig ... end`

Boolean signals

`module Option : sig ... end`

Option signals

`module Pair : sig ... end`

Pair signals.

On This Page