package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

batteries-3.10.0.tar.gz
md5=b7f3b99f12f21b1da6b6aa13d993206d
sha512=8b7f2479eb0271bcfd9168887c1e4a9a815c512eab3ee61b150fc4dfa9ec803e4f73115155f20b3017e4a822148d0e6d1c1e8e5f96790fd691b419dd39a908a2

doc/batteries.unthreaded/BatBool/index.html

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