ocaml-containers/src/core/CCBool.mli
2020-03-16 21:22:51 +01:00

28 lines
773 B
OCaml

(* This file is free software, part of containers. See file "license" for more details. *)
(** {1 Basic Bool functions} *)
type t = bool
val compare : t -> t -> int
(** [compare b1 b2] is the total ordering on booleans [b1] and [b2], similar to {!Pervasives.compare}. *)
val equal : t -> t -> bool
(** [equal b1 b2] is [true] if [b1] and [b2] are the same. *)
val to_int : t -> int
(** [to_int true = 1], [to_int false = 0].
@since 2.7 *)
val of_int : int -> t
(** [of_int i] is the same as [i <> 0]
@since 2.7 *)
val negate : t -> t
(** Negation on booleans (functional version of [not]).
@deprecated since 1.3, simply use {!not} instead. *)
[@@ocaml.deprecated "use `not` instead"]
type 'a printer = Format.formatter -> 'a -> unit
val pp : t printer