Comparable (docs.findlib-1.core.Core.Tuple.Comparable)

Parameters

module S1 : Comparable_sexpable

module S2 : Comparable_sexpable

Signature

include Sexplib0.Sexpable.S with type t := Make(S1)(S2).t

val t_of_sexp : Sexplib0.Sexp.t -> Make(S1)(S2).t

val sexp_of_t : Make(S1)(S2).t -> Sexplib0.Sexp.t

include Comparable.S with type t := Make(S1)(S2).t

include Base.Comparable.S with type t := Make(S1)(S2).t

include Base.Comparisons.S with type t := Make(S1)(S2).t

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

include Base.Comparator.S with type t := Make(S1)(S2).t

type comparator_witness

val comparator : 
  (Make(S1)(S2).t, comparator_witness) Base.Comparator.comparator

val validate_lbound : 
  min:Make(S1)(S2).t Maybe_bound.t ->
  Make(S1)(S2).t Validate.check

val validate_ubound : 
  max:Make(S1)(S2).t Maybe_bound.t ->
  Make(S1)(S2).t Validate.check

val validate_bound : 
  min:Make(S1)(S2).t Maybe_bound.t ->
  max:Make(S1)(S2).t Maybe_bound.t ->
  Make(S1)(S2).t Validate.check

module Replace_polymorphic_compare : 
  Base.Comparable.Comparisons with type t := Make(S1)(S2).t

module Map : 
  Map.S
    with type Key.t = Make(S1)(S2).t
    with type Key.comparator_witness = comparator_witness

module Set : 
  Set.S
    with type Elt.t = Make(S1)(S2).t
    with type Elt.comparator_witness = comparator_witness