package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

dune-project

Dependency

batteries.forge.ocamlcore.org Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.2.0.tar.gz

sha256=00f34b9aed4e47f314425b2ca9ceac206f112095a17ea9a7ffa6dac8cfccc492

md5=066051f9a210277710c54ad57c3b9568

doc/batteries.unthreaded/BatBounded/module-type-NumericSig/index.html

Module type `BatBounded.NumericSig`

include S

type base_u

Raw unbounded type

type u

base_u after bounding constraints have been applied

type t = private u

Private version of u to avoid construction of t values without using make below.

val bounds : base_u bound_t * base_u bound_t

bounds defines the (min, max) bounds for the bounded range

val make : base_u -> t

make x will return a value of type t derived from x.

val extract : t -> u

extract x will return x as a value of type u. A similar result could be achieved with (x :> u)

val map : (base_u -> base_u) -> t -> t option

map f x applies f to x. Returns Some y if x can be converted back to type base_u, otherwise returns None.

val map2 : (base_u -> base_u -> base_u) -> t -> t -> t option

map2 f x y applies f to x and y. Returns Some z if x and y can be converted back to type base_u, otherwise returns None.

val map_exn : (base_u -> base_u) -> t -> t

map_exn f x applies f to x. Returns y if x can be converted back to type base_u, otherwise raise an exception.

val map2_exn : (base_u -> base_u -> base_u) -> t -> t -> t

map2_exn f x y applies f to x and y. Returns z if x and y can be converted back to type base_u, otherwise raise an exception.

val (+) : t -> base_u -> t

val (-) : t -> base_u -> t

val (*) : t -> base_u -> t

val (/) : t -> base_u -> t

val (+:) : t -> t -> t

val (-:) : t -> t -> t

val (*:) : t -> t -> t

val (/:) : t -> t -> t