Module Base.Sign

A simple type for representing the sign of a numeric value.

type t = Base__.Sign0.t =
| Neg
| Zero
| Pos
include sig ... end
val all : t list
val hash_fold_t : Hash.state ‑> t ‑> Hash.state
val hash : t ‑> Hash.hash_value

This provides to_string/of_string, sexp conversion, Map, Hashtbl, etc.

include Identifiable.S with type t := t
type t
include sig ... end
val hash_fold_t : Hash.state ‑> t ‑> Hash.state
val hash : t ‑> Hash.hash_value
val t_of_sexp : Sexp.t ‑> t
val sexp_of_t : t ‑> Sexp.t
include Stringable.S with type t := t
type t
val of_string : string ‑> t
val to_string : t ‑> string
include Comparable.S with type t := t
include Comparable_intf.Polymorphic_compare
include Comparisons.Infix
type t
val (>=) : t ‑> t ‑> bool
val (<=) : t ‑> t ‑> bool
val (=) : t ‑> t ‑> bool
val (>) : t ‑> t ‑> bool
val (<) : t ‑> t ‑> bool
val (<>) : t ‑> t ‑> bool
val equal : t ‑> t ‑> bool
val 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.

val min : t ‑> t ‑> t
val max : t ‑> t ‑> t
val 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 ~cmp:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t ‑> t ‑> int
val between : t ‑> low:t ‑> high:t ‑> bool
val 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).

val clamp : t ‑> min:t ‑> max:t ‑> t Or_error.t
include Comparator.S with type t := t
type t
type comparator_witness
include Comparable_intf.Validate with type t := t
type t
val validate_lbound : min:t Maybe_bound.t ‑> t Validate.check
val validate_ubound : max:t Maybe_bound.t ‑> t Validate.check
val validate_bound : min:t Maybe_bound.t ‑> max:t Maybe_bound.t ‑> t Validate.check
include Pretty_printer.S with type t := t
type t
val pp : Caml.Format.formatter ‑> t ‑> unit
val of_int : int ‑> t
val to_int : t ‑> int

Map Neg/Zero/Pos to -1/0/1 respectively.

val to_float : t ‑> float

Map Neg/Zero/Pos to -1./0./1. respectively. (There is no of_float here, but see Float.sign_exn.)

val flip : t ‑> t

Map Neg/Zero/Pos to Pos/Zero/Neg respectively.

val (*) : t ‑> t ‑> t

Neg * Neg = Pos, etc.