Module ReactiveData.RListSource

Reactive list data structure

Sourcetype 'a p =
  1. | I of int * 'a
    (*

    I (i, v) adds v at position i

    *)
  2. | R of int
    (*

    R i removes i-th element

    *)
  3. | U of int * 'a
    (*

    U (i, v) substitutes i-th element with v

    *)
  4. | X of int * int
    (*

    X (i, j) swaps the i-th and j-th elements

    *)

Patch operation on lists. All operations are of linear complexity.

Sourcetype 'a patch = 'a p list

A patch is a list of patch operations. The operations are applied in the order they appear in the list.

The indices correspond to list contents after the operations that appear earlier in the list have been applied, not to the contents before the whole patch operation.

A patch comprised of I, R, and U steps with increasing indices can be applied in time O(m + n), where m is the patch length and n is the current size of the list. (Arbitrary patches are slower, requiring O(m * n).)

include S with type 'a data = 'a list and type 'a patch := 'a patch
Sourcetype 'a t

Reactive version of the data container

Sourcetype 'a data = 'a list

Raw (non-reactive) version of the data container

Sourcetype 'a msg =
  1. | Patch of 'a patch
    (*

    Patch p triggers the application of p on the current contents

    *)
  2. | Set of 'a data
    (*

    With Set d, d becomes the new content

    *)

Message format

Sourcetype 'a handle

Handle that permits applying incremental updates

Sourceval empty : 'a t

Empty data structure

Sourceval create : 'a data -> 'a t * 'a handle

Build a container from initial contents. The handle can be used for performing reactive updates.

Sourceval from_event : 'a data -> 'a msg React.E.t -> 'a t

from_event d e is a container whose initial value is d, and which gets updated for every occurrence of e

Sourceval from_signal : ?eq:('a -> 'a -> bool) -> 'a data React.S.t -> 'a t

Convert a React signal into a ReactiveData container.

Whenever the signal changes from value v to value v', we detect the differences between v and v', and perform downstream computation (e.g., for map) only on the new and modified elements.

Sourceval const : 'a data -> 'a t

Produce a constant container

Sourceval patch : 'a handle -> 'a patch -> unit

patch h p applies p on the container corresponding to h

Sourceval set : 'a handle -> 'a data -> unit

set h d sets the contents of the container corresponding to h, disregarding previous contents

Sourceval map_msg : ('a -> 'b) -> 'a msg -> 'b msg

Transform a message

Sourceval map : ('a -> 'b) -> 'a t -> 'b t

map f c applies f on all elements of c, producing a new reactive container c'. Modifying the contents of c leads to modifications of c'. f is applied only on the new or modified elements of c.

Sourceval value : 'a t -> 'a data

Return current contents

Sourceval fold : ('a -> 'b msg -> 'a) -> 'b t -> 'a -> 'a React.signal

fold f c v accumulates the updates on c with f starting from v.

The result is a signal of value f m_n (f ... (f m_1 v)), where m_1 ... m_n are the messages that have been applied since the beginning of fold. m_1 is a pseudo-message Set l, accounting for the contents l of c at the time when accumulation starts.

Sourceval signal : ?eq:('a -> 'a -> bool) -> 'a t -> 'a data React.S.t

Signal corresponding to contents

Sourceval event : 'a t -> 'a msg React.E.t

Event whose occurrences correspond to container updates

Sourceval cons : 'a -> 'a handle -> unit

Add element to the beginning

Sourceval snoc : 'a -> 'a handle -> unit

Add element to the end

Sourceval insert : 'a -> int -> 'a handle -> unit

insert v i h adds v as the i-th position in the container corresponding to h. The indices of the subsequent elements change.

Sourceval remove : int -> 'a handle -> unit

remove i h removes the i-th position from the container corresponding to h. The indices of the subsequent elements change.

Sourceval remove_last : ('a t * 'a handle) -> unit

remove_last a removes the last element of a

Sourceval remove_eq : ?eq:('a -> 'a -> bool) -> ('a t * 'a handle) -> 'a -> unit

remove_eq l x removes the first occurence of x from l

Sourceval update : 'a -> int -> 'a handle -> unit

update v i h substitutes the i-th element of the container corresponding to h with v

Sourceval update_eq : ?eq:('a -> 'a -> bool) -> ('a t * 'a handle) -> 'a -> 'a -> unit

update_eq l a b substitutes the first occurence of a (according to eq) in l with b

Sourceval move : int -> int -> 'a handle -> unit

move i offset h moves the i-th element of the container corresponding by offset positions in h, modifying the indices of other elements

Sourceval singleton : 'a -> 'a t

Produce container list containing a single, constant element

Sourceval singleton_s : 'a React.S.t -> 'a t

Produce reactive list containing a single element that gets updated based on a signal

Sourceval concat : 'a t -> 'a t -> 'a t

concat a b is the concatenation of a and b, and it gets updated whenever a and b change

Sourceval rev : 'a t -> 'a t

rev a is the reversal of a; rev a gets updated along with a

Sourceval filter : ('a -> bool) -> 'a t -> 'a t

filter pred l keeps the elements of l matching pred; gets updated when l is. pred should be a pure function

Sourceval for_all : ('a -> bool) -> 'a t -> bool React.S.t

for_all fn l is a bool React.S.t verifying that all elements x of l satisfy fn x