package hardcaml_verify

  1. Overview
  2. Docs
package hardcaml_verify
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Uid : sig ... end
type t
include Ppx_compare_lib.Comparable.S with type t := t
val sexp_of_t : t -> Sexplib0.Sexp.t
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 uid : t -> Uid.t
val vdd : t
val gnd : t
val is_vdd : t -> Base.bool
val is_gnd : t -> Base.bool
val var : Label.t -> t
val (~:) : t -> t
val (|:) : t -> t -> t
val (^:) : t -> t -> t
val (&:) : t -> t -> t
val cofactor : var:t -> t -> f:t -> t

cofactor ~var p ~f computes the cofactor of f wrt to var. p=vdd for positive cofactor and p=gnd for negative cofactor

val difference : t -> f:t -> t

boolean difference

val forall : t -> f:t -> t

universal quantification

val exists : t -> f:t -> t

existential quantification

val shannon_expansion : t -> f:t -> t

F = xF_x + x'F_x'

val deps : t -> t Base.list

Gate inputs

Visit all nodes in the list of functions and call f. Nodes are visited once only.

val cnf : ?show_hidden:Base.bool -> t Base.list -> Cnf.t

Create CNF for each given equation. In the resulting CNF the equations are logically AND'd.