package bonsai

  1. Overview
  2. Docs
package bonsai
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t

Represents the shortest unambiguous path through the Computation.t data structure, including the path through any contained Value.ts. Several of the constructors in Computation.t only contain a single inner computation or value; thus, keeping track of these segments in all the paths is often unnecessary. Thus, we can more properly model this path as with two parts:

  • the list of choices made; nodes which do not require a choice do not make it into the list.
  • a number representing the amount of nodes descended into after the last choice point.

Whenever a choice point gets added, we reset the number of nodes descended back to 0, since that number is no longer helpful for keeping the paths unique.

include Core.Bin_prot.Binable.S with type t := t
val bin_size_t : t Bin_prot__.Size.sizer
val bin_write_t : t Bin_prot__.Write.writer
val bin_read_t : t Bin_prot__.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot__.Read.reader
val bin_shape_t : Bin_prot__.Shape.t
val bin_writer_t : t Bin_prot__.Type_class.writer
val bin_reader_t : t Bin_prot__.Type_class.reader
val bin_t : t Bin_prot__.Type_class.t
include Sexplib0.Sexpable.S with type t := t
val t_of_sexp : Sexplib0__.Sexp.t -> t
val sexp_of_t : t -> Sexplib0__.Sexp.t
include Core.Comparable.S_binable with type t := t
include Base.Comparable.S with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
module Replace_polymorphic_compare : sig ... end
include Core.Comparator.S with type t := t with type comparator_witness := comparator_witness

The of_string and to_string functions operate on short, yet semi-human-readable strings.

For example:

{ choices = [ 1; 2; 3]; descend = 4 }

is serialized to "1-2-3_4"

include Core.Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
type builder
val empty : builder

The empty node path.

val choice_point : builder -> int -> builder

Adds a choice point to that input path. The provided number says which of the choices at that point was taken. When traversing a computation or value, if any case has multiple recursive calls, you should add a choice point to the path built up in each of those calls, with each call using a different number.

val descend : builder -> builder

Adds an extra segment to the input path. All such segments get forgotten when the next choice point is added.

val finalize : builder -> t
module Stable : sig ... end
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