Module Tuple.Comparable_plain

Parameters

module S1 : Comparable.S_plain
module S2 : Comparable.S_plain

Signature

type comparator_witness = (S1.comparator_witness, S2.comparator_witness) T2.comparator_witness
include Comparable.S_plain with type t := Make(S1)(S2).t with type comparator_witness := comparator_witness
include Base.Comparable.S with type t := Make(S1)(S2).t and type comparator_witness := comparator_witness
include Base.Comparisons.Infix with type t := Make(S1)(S2).t
val (>=) : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val (<=) : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val (=) : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val (>) : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val (<) : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val (<>) : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val equal : Make(S1)(S2).t -> Make(S1)(S2).t -> bool
val compare : Make(S1)(S2).t -> Make(S1)(S2).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 : Make(S1)(S2).t -> Make(S1)(S2).t -> Make(S1)(S2).t
val max : Make(S1)(S2).t -> Make(S1)(S2).t -> Make(S1)(S2).t
val ascending : Make(S1)(S2).t -> Make(S1)(S2).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.

val descending : Make(S1)(S2).t -> Make(S1)(S2).t -> int
val between : Make(S1)(S2).t -> low:Make(S1)(S2).t -> high:Make(S1)(S2).t -> bool

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

val clamp_exn : Make(S1)(S2).t -> min:Make(S1)(S2).t -> max:Make(S1)(S2).t -> Make(S1)(S2).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 : Make(S1)(S2).t -> min:Make(S1)(S2).t -> max:Make(S1)(S2).t -> Make(S1)(S2).t Base.Or_error.t
module Replace_polymorphic_compare : sig ... end