package hardcaml_verify

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

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.

module Uid : sig ... end
type t
include Ppx_compare_lib.Comparable.S with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
val 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
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

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.

val min : t -> t -> t
val max : t -> t -> t
val 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.

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

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

val 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).

val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
type comparator_witness
val create : ?width:Base.int -> ?hidden:Base.bool -> Base.string -> t Base.array
val create1 : ?hidden:Base.bool -> Base.string -> t
val uid : t -> Uid.t
val bit_pos : t -> Base.int
val name : t -> Base.string
val hidden : t -> Base.bool