package batteries

  1. Overview
  2. Docs
package batteries
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module BatBoolSource

Operations on booleans

  • author Gabriel Scherer
  • author David Teller
Sourcetype t = bool

The type of booleans. Formally, this is defined as type t = true | false

Sourceval not : bool -> bool

The boolean negation.

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

The boolean ``and''. Evaluation is sequential, left-to-right: in e1 && e2, e1 is evaluated first, and if it returns false, e2 is not evaluated at all.

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

The boolean ``or''. Evaluation is sequential, left-to-right: in e1 || e2, e1 is evaluated first, and if it returns true, e2 is not evaluated at all.

Sourceval zero : bool
Sourceval one : bool
Sourceval neg : bool -> bool
Sourceval succ : bool -> bool
Sourceval pred : bool -> bool
Sourceval abs : bool -> bool
Sourceval add : bool -> bool -> bool
Sourceval mul : bool -> bool -> bool
Sourceval sub : bool -> bool -> bool
Sourceval div : t -> t -> t
Sourceval modulo : t -> t -> t
Sourceval pow : t -> t -> t
Sourceval compare : bool -> bool -> int
Sourceval equal : bool -> bool -> bool
Sourceval ord : bool -> bool -> BatOrd.order
Sourceval of_int : int -> bool

anything but 0 is true

Sourceval to_int : bool -> int
Sourceval of_string : string -> bool

Convert the given string to a boolean.

  • raises Invalid_argument

    if the string is not "true", "false", "0", "1", "tt" or "ff".

Sourceval to_string : bool -> string
Sourceval of_float : float -> bool

0., nan +infinity and -infiity are false. The other values convert to true

Sourceval to_float : bool -> float
Sourceval (+) : t -> t -> t
Sourceval (-) : t -> t -> t
Sourceval (*) : t -> t -> t
Sourceval (/) : t -> t -> t
Sourceval (**) : t -> t -> t
Sourceval (--) : t -> t -> t BatEnum.t
Sourceval (---) : t -> t -> t BatEnum.t
Sourceval operations : t BatNumber.numeric
include BatNumber.Bounded
Sourcetype bounded
Sourceval min_num : bounded
Sourceval max_num : bounded

Submodules grouping all infix operators

Boilerplate code

Sourceval print : 'a BatInnerIO.output -> t -> unit

Printing

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct