package base

You can search for identifiers within the package.

in-package search v0.2.0

Full standard library replacement for OCaml

Install

Dune Dependency

github.com Changelog MIT License Edit opam file Versions (19)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.15.1.tar.gz

sha256=755e303171ea267e3ba5af7aa8ea27537f3394d97c77d340b10f806d6ef61a14

doc/base/Base/Bool/index.html

Module `Base.Bool`Source

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

Sourcetype t = bool

Sourceval all : t list

include Sexplib0.Sexpable.S with type t := t

Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t

include Identifiable.S with type t := t

Sourceval hash_fold_t : Hash.state -> t -> Hash.state

Sourceval hash : t -> Hash.hash_value

include Sexplib0.Sexpable.S with type t := t

Sourceval t_of_sexp : Sexplib0.Sexp.t -> t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

include Stringable.S with type t := t

Sourceval of_string : string -> t

Sourceval 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

Sourceval (>=) : t -> t -> bool

Sourceval (<=) : t -> t -> bool

Sourceval (=) : t -> t -> bool

Sourceval (>) : t -> t -> bool

Sourceval (<) : t -> t -> bool

Sourceval (<>) : t -> t -> bool

Sourceval equal : t -> t -> bool

Sourceval 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.

Sourceval min : t -> t -> t

Sourceval max : t -> t -> t

Sourceval 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.

Sourceval descending : t -> t -> int

Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval 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).

Sourceval clamp : t -> min:t -> max:t -> t Or_error.t

include Comparator.S with type t := t

Sourcetype comparator_witness

Sourceval comparator : (t, comparator_witness) Comparator.comparator

include Pretty_printer.S with type t := t

Sourceval pp : Formatter.t -> t -> unit

Sourceval hashable : t Hashable.t

include Invariant.S with type t := t

Sourceval invariant : t -> unit

Sourceval to_int : t -> int

to_int true = 1
to_int false = 0

Sourcemodule Non_short_circuiting : sig ... end

Non-short circuiting and branch-free boolean operators.