package hardcaml_verify

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

Module Hardcaml_verify_kernel.LabelSource

Labels represent named variables. They contain a uid (unique identifier) which is constructed when the label is created. The name is not used for comparison.

We need to represent vectors, even though the core variable type is a single bit. As such labels also refer to their bit position. The pair (uid,bit_pos) is used for comparison in order to distinguish labels.

Sourcemodule Uid : sig ... end
Sourcetype t
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval to_string : t -> Base.string
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

Sourceval descending : t -> t -> int
Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
Sourcetype comparator_witness
Sourceval create : ?width:Base.int -> ?hidden:Base.bool -> Base.string -> t Base.array
Sourceval create1 : ?hidden:Base.bool -> Base.string -> t
Sourceval uid : t -> Uid.t
Sourceval bit_pos : t -> Base.int
Sourceval name : t -> Base.string
Sourceval hidden : t -> Base.bool
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