Legend:
Library
Module
Module type
Parameter
Class
Class type

Boolean type extended to be enumerable, hashable, sexpable, comparable, and stringable.

type t = bool
val all : t list
include Sexpable.S with type t := t
include Identifiable.S with type t := t
val hash_fold_t : t -> Hash.state
val hash : t -> Hash.hash_value
include Sexpable.S with type t := t
val t_of_sexp : t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
include Comparable.S with type t := t
include Comparisons.S with type t := t
include 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 ->
include Comparator.S with type t := t
type comparator_witness
val comparator :
val validate_lbound : min: ->
val validate_ubound : max: ->
val validate_bound : min: -> max: ->
include Pretty_printer.S with type t := t
val pp : t -> unit
include Invariant.S with type t := t
val invariant : t -> unit
val to_int : t -> int
• to_int true = 1
• to_int false = 0
module Non_short_circuiting : sig ... end

Non-short circuiting and branch-free boolean operators.