package incremental

You can search for identifiers within the package.

in-package search v0.2.0

incremental
- Incremental
  - Before_or_after
  - Clock
  - Config
    
    Default
    
    Incremental_config
  - Cutoff
  - Expert
    
    Dependency
    
    Node
    
    Step_result
  - For_analyzer
    
    Cutoff
    
    Dot_user_info
    
    Kind
    
    Node_id
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Stabilization_num
    
    Map
    
    Diff
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Diff
    
    Elt
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
  - Infix
  - Let_syntax
    
    Let_syntax
    
    Open_on_rhs
  - Make
    
    Before_or_after
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Step_result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Node_value
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
  - Make_with_config
    
    Before_or_after
    
    C
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Step_result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Node_value
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
  - Node_value
  - Observer
    
    Update
  - Packed
  - Private
  - S
    
    Before_or_after
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Step_result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Node_value
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
  - S_gen
    
    Before_or_after
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Step_result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Node_value
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
  - Scope
  - State
    
    S
    
    Stats
  - Unordered_array_fold_update
  - Update
  - Var
incremental.incremental_step_function
- Incremental_step_function
incremental.memoize
- Incr_memoize
  - Make
    
    Incr
    
    Before_or_after
    
    Clock
    
    Cutoff
    
    Expert
    
    Dependency
    
    Node
    
    Step_result
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Node_value
    
    Observer
    
    Update
    
    Packed
    
    Scope
    
    State
    
    Stats
    
    Unordered_array_fold_update
    
    Update
    
    Var
    
    Incr_with_store_params
    
    Let_syntax
    
    Let_syntax
  - Store
  - Store_params

Legend:
Library
Module
Module type
Parameter
Class
Class type

type ('a, 'w) t

val sexp_of_t : 
  ('a -> Sexplib0.Sexp.t) ->
  ('w -> Sexplib0.Sexp.t) ->
  ('a, 'w) t ->
  Sexplib0.Sexp.t

include Core.Invariant.S2 with type ('a, 'b) t := ('a, 'b) t

val invariant : 
  'a Base__Invariant_intf.inv ->
  'b Base__Invariant_intf.inv ->
  ('a, 'b) t Base__Invariant_intf.inv

val observing : ('a, 'w) t -> ('a, 'w) incremental

val use_is_allowed : (_, _) t -> bool

val value : ('a, _) t -> 'a Core.Or_error.t

value t returns the current value of t, or Error if t does not currently have a stable value. In particular, value t will return Error in the following situations:

in the middle of stabilization.
if stabilize has not been called since t was created.
if disallow_future_use t has been called.
if observing t is invalid.

Rather than using value in a function that runs during stabilization, one should use map or bind to express the dependence of an incremental computation on an incremental.

val value_exn : ('a, _) t -> 'a

module Update : sig ... end

val on_update_exn : ('a, _) t -> f:('a Update.t -> unit) -> unit

on_update_exn t ~f calls f after the current stabilization and after each subsequent stabilization in which t changes, until disallow_future_use t is called. f will be called at most once per stabilization. Here is a state diagram for the allowable sequences of Update.t's that can be supplied to a particular f:

           /-----------------------------------------------------\
           |                 /                                   |
           |                 |                                   v
          Start ------> Initialized ------> Changed ------> Invalidated
                                              ^  |
                                              \--/

on_update_exn raises if disallow_future_use t was previously called.

val disallow_future_use : (_, _) t -> unit

After disallow_future_use t:

on_update_exn t and value_exn t will raise, and value t will return Error.
t's on-update handlers will never run again.
At the next call to stabilize, before recomputing nodes, incremental will mark t as unobserved, and mark as unnecessary all nodes that were necessary only to maintain t.