package containers

  1. Overview
  2. Docs
A modular, clean and powerful extension of the OCaml standard library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (23)

Authors

  1. C
    c-cube

Maintainers

  1. C
    c-cube

Sources

containers-3.18.tbz
sha256=52eeff91ce42b52305e6aaa8a58b88ce8f0a5a984199e59ca7e2fd9ebabe61d7
sha512=dc7337e6cbc9850542c7c9228d3bcb4e4add57a55e2a2992f21fb4761b3e10a68ef1d57ca37a7f5b303fc875fe3df5ecb69dbf2930bfcd1561ce03f7ae83e24b

doc/containers/CCBool/index.html

Module CCBoolSource

Basic Bool functions

Booleans

Sourcetype t = bool =
  1. | false
  2. | true

The type of booleans (truth values).

The constructors false and true are included here so that they have paths, but they are not intended to be used in user-defined data types.

Sourceval not : bool -> bool

not b is the boolean negation of b.

Sourceval (&&) : bool -> bool -> bool

e0 && e1 is the lazy boolean conjunction of expressions e0 and e1. If e0 evaluates to false, e1 is not evaluated. Right-associative operator at precedence level 3/11.

Sourceval (||) : bool -> bool -> bool

e0 || e1 is the lazy boolean disjunction of expressions e0 and e1. If e0 evaluates to true, e1 is not evaluated. Right-associative operator at precedence level 2/11.

Sourceval logand : bool -> bool -> bool

logand b1 b2 is true if and only if b1 and b2 are both true.

Sourceval logor : bool -> bool -> bool

logor b1 b2 is true if and only if either b1 or b2 is true.

Sourceval logxor : bool -> bool -> bool

logxor b1 b2 is true if exactly one of b1 and b2 is true.

Predicates and comparisons

Sourceval equal : bool -> bool -> bool

equal b0 b1 is true if and only if b0 and b1 are both true or both false.

Sourceval compare : bool -> bool -> int

compare b0 b1 is a total order on boolean values. false is smaller than true.

Converting

Sourceval to_int : bool -> int

to_int b is 0 if b is false and 1 if b is true.

Sourceval to_float : bool -> float

to_float b is 0. if b is false and 1. if b is true.

Sourceval to_string : bool -> string

to_string b is "true" if b is true and "false" if b is false.

Sourceval seeded_hash : int -> bool -> int

A seeded hash function for booleans, with the same output value as Hashtbl.seeded_hash. This function allows this module to be passed as argument to the functor Hashtbl.MakeSeeded.

  • since 5.1
Sourceval hash : bool -> int

An unseeded hash function for booleans, with the same output value as Hashtbl.hash. This function allows this module to be passed as argument to the functor Hashtbl.Make.

  • since 5.1
Sourceval if_then : (unit -> 'a) -> t -> 'a option

if_then f x is Some (f ()) if x is true and None otherwise.

  • since 3.13
Sourceval if_then_else : (unit -> 'a) -> (unit -> 'a) -> t -> 'a

if_then_else f g x is f () if x is true and g () otherwise.

  • since 3.13
Sourceval of_int : int -> t

of_int i is the same as i <> 0

  • since 2.7
Sourcetype 'a printer = Format.formatter -> 'a -> unit
Sourceval pp : t printer