package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

Signature

include Comparable.S_plain with type t := Tuple.Make(S1)(S2).t with type comparator_witness := comparator_witness
include Base.Comparable.S with type t := Tuple.Make(S1)(S2).t with type comparator_witness := comparator_witness
include Base.Comparisons.S with type t := Tuple.Make(S1)(S2).t
include Base.Comparisons.Infix with type t := Tuple.Make(S1)(S2).t

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 ascending : Tuple.Make(S1)(S2).t -> Tuple.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 : Tuple.Make(S1)(S2).t -> Tuple.Make(S1)(S2).t -> int

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

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).

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