package incremental

  1. Overview
  2. Docs
package incremental
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Incremental.StateSource

A State.t holds shared state used by all the incremental functions.

Sourcetype 'w t
Sourceval sexp_of_t : ('w -> Sexplib0.Sexp.t) -> 'w t -> Sexplib0.Sexp.t
Sourcemodule type S = sig ... end
Sourceval create : ?max_height_allowed:int -> unit -> (module S)
Sourceval keep_node_creation_backtrace : _ t -> bool

If keep_node_creation_backtrace, then whenever a new node is created, incremental will call Backtrace.get and store the result in the node. The backtrace will then appear in subsequent error messages when the node is pretty printed.

Sourceval set_keep_node_creation_backtrace : _ t -> bool -> unit
Sourceval max_height_allowed : _ t -> int
Sourceval set_max_height_allowed : _ t -> int -> unit

set_max_height_allowed t height sets the maximum allowed height of nodes. set_max_height_allowed raises if called during stabilization, or if height < max_height_seen t.

Sourceval num_active_observers : _ t -> int

num_active_observers returns (in constant time) the number of observers that have been created and not yet disallowed (either explicitly or via finalization).

constant-time stats

These are counters that are constant time to read, and that are automatically updated in the ordinary course.

Sourceval max_height_seen : _ t -> int
Sourceval num_nodes_became_necessary : _ t -> int
Sourceval num_nodes_became_unnecessary : _ t -> int
Sourceval num_nodes_changed : _ t -> int

Number of times a node has seen its value changed, the determination of which depends on the choice of cutoff.

Sourceval num_nodes_created : _ t -> int
Sourceval num_nodes_invalidated : _ t -> int
Sourceval num_nodes_recomputed : _ t -> int
Sourceval num_nodes_recomputed_directly_because_one_child : _ t -> int
Sourceval num_nodes_recomputed_directly_because_min_height : _ t -> int
Sourceval num_stabilizes : _ t -> int
Sourceval num_var_sets : _ t -> int
Sourcemodule Stats : sig ... end

Stats contains information about the DAG intended for human consumption.

Sourceval stats : _ t -> Stats.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct