package hardcaml_verify

You can search for identifiers within the package.

in-package search v0.2.0

Hardcaml Verification Tools

Install

Dune Dependency

github.com Readme MIT License Edit opam file Versions (3)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

hardcaml_verify-v0.15.0.tar.gz

sha256=a469d63c76bd86fbd04aa38d391dc736d4bc291ad5ffe0090b31cc4ae3ba6622

doc/hardcaml_verify.kernel/Hardcaml_verify_kernel/Label/index.html

Module `Hardcaml_verify_kernel.Label`Source

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 comparator : (t, comparator_witness) Base.Comparator.comparator

Source

val 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