Module Base.SignSource

A type for representing the sign of a numeric value.

Sourcetype t =
  1. | Neg
  2. | Zero
  3. | Pos
Sourceval all : t list
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t

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

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
include Pretty_printer.S with type t := t
Sourceval pp : Formatter.t -> t -> unit
Sourceval hashable : t Hashable.t
Sourceval to_string_hum : t -> string

Returns the human-readable strings "positive", "negative", "zero".

Sourceval of_int : int -> t
Sourceval to_int : t -> int

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

Sourceval to_float : t -> float

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

Sourceval flip : t -> t

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

Sourceval (*) : t -> t -> t

Neg * Neg = Pos, etc.