package jhupllib
-
jhupllib
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package jhupllib
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
This module provides a means by which a registry of "witnesses" can be created. Here, a witness is a representative of another (typically more complex) value. A witness registry is a mutable structure which monotonically accumulates values, mapping distinct values to distinct witnesses. The primary use of such a registry is to accelerate comparison operations. For instance, using witnesses as keys in a tree-based dictionary may be faster than using the original values if the comparison between two values is an expensive operation.
module type Spec = sig ... endThis module type describes the information required to create a witness registry module.
module type Registry = sig ... endThis is the type of a witness registry module.
module type Escorted_registry = sig ... endThe type of a registry with an escort. Escorts pair the witnesses with their registries to make operations such as pretty-printing easier. This module only defines escorts and their basic comparison operations. More operations can be added by including utils modules produced by the other functors in this module.
module Make_escorted (S : Spec) : Escorted_registry with type elt = S.tA functor to make registries with escorts.
module type Pp_utils = sig ... endThe type of a pretty-printing utility module for witness registries.
module Make_pp
(R : Escorted_registry)
(P : Jhupllib_pp_utils.Pp with type t = R.elt) :
Pp_utils with type escorted_witness := R.escorted_witnessA functor to produce a pretty-printing utility module.
module type To_yojson_utils = sig ... endThe type of a to-yojson utility module for witness registries.
module Make_to_yojson
(R : Escorted_registry)
(Y : Jhupllib_yojson_utils.To_yojson_type with type t = R.elt) :
To_yojson_utils with type escorted_witness := R.escorted_witnessA functor to produce a pretty-printing utility module.