Module Identifiable.Make

Used for making an Identifiable module. Here's an example.

module Id = struct
  module T = struct
    type t = A | B [@@deriving compare, hash, sexp]
    let of_string s = t_of_sexp (sexp_of_string s)
    let to_string t = string_of_sexp (sexp_of_t t)
    let module_name = "My_library.Id"
  end
  include T
  include Identifiable.Make (T)
end

Parameters

module M : sig ... end

Signature

val hash_fold_t : Hash.state -> M.t -> Hash.state
val hash : M.t -> Hash.hash_value
include Sexpable.S with type t := M.t
val t_of_sexp : Sexplib0.Sexp.t -> M.t
val sexp_of_t : M.t -> Sexplib0.Sexp.t
include Stringable.S with type t := M.t
val of_string : string -> M.t
val to_string : M.t -> string
include Comparable.S with type t := M.t
include Comparisons.S with type t := M.t
include Comparisons.Infix with type t := M.t
val (>=) : M.t -> M.t -> bool
val (<=) : M.t -> M.t -> bool
val (=) : M.t -> M.t -> bool
val (>) : M.t -> M.t -> bool
val (<) : M.t -> M.t -> bool
val (<>) : M.t -> M.t -> bool
val equal : M.t -> M.t -> bool
val compare : M.t -> M.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 : M.t -> M.t -> M.t
val max : M.t -> M.t -> M.t
val ascending : M.t -> M.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 : M.t -> M.t -> int
val between : M.t -> low:M.t -> high:M.t -> bool

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

val clamp_exn : M.t -> min:M.t -> max:M.t -> M.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 : M.t -> min:M.t -> max:M.t -> M.t Or_error.t
include Comparator.S with type t := M.t
type comparator_witness
val validate_lbound : min:M.t Maybe_bound.t -> M.t Validate.check
val validate_ubound : max:M.t Maybe_bound.t -> M.t Validate.check
val validate_bound : min:M.t Maybe_bound.t -> max:M.t Maybe_bound.t -> M.t Validate.check
include Pretty_printer.S with type t := M.t
val pp : Formatter.t -> M.t -> unit