package core_kernel

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

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

module Id = struct
  module T = struct
    type t = A | B [@@deriving bin_io, compare, hash, sexp]
    include Sexpable.To_stringable (struct type nonrec t = t [@@deriving sexp] end)
    let module_name = "My_library.Std.Id"
  end
  include T
  include Identifiable.Make (T)
end

Parameters

module M : sig ... end

Signature

include sig ... end
val bin_read_t : M.t Bin_prot.Read.reader
val __bin_read_t__ : (Base.Int.t -> M.t) Bin_prot.Read.reader
val bin_reader_t : M.t Bin_prot.Type_class.reader
val bin_size_t : M.t Bin_prot.Size.sizer
val bin_write_t : M.t Bin_prot.Write.writer
val bin_writer_t : M.t Bin_prot.Type_class.writer
val bin_shape_t : Bin_prot.Shape.t
val t_of_sexp : Sexplib.Sexp.t -> M.t
val sexp_of_t : M.t -> Sexplib.Sexp.t
include Base.Stringable.S with type t := M.t
val of_string : string -> M.t
val to_string : M.t -> string
include Comparable.S_binable with type t := M.t
include Base.Comparable_intf.S with type t := M.t
include Base.Comparable_intf.Polymorphic_compare with type t := M.t
include Base.Polymorphic_compare_intf.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

-1 means "less than", 0 means "equal", 1 means "greater than", and other values should not be returned

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 ~cmp: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
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 Base.Or_error.t
include Base.Comparator.S with type t := M.t
type comparator_witness
include Base.Comparable_intf.Validate with type t := M.t
val validate_lbound : min:M.t Base.Maybe_bound.t -> M.t Base.Validate.check
val validate_ubound : max:M.t Base.Maybe_bound.t -> M.t Base.Validate.check
include Hashable.S_binable with type t := M.t
val hash : M.t -> Base.Int.t
module Hash_set : Hash_set.S_binable with type elt = M.t
module Hash_queue : Hash_queue.S with type Key.t = M.t
include Base.Pretty_printer.S with type t := M.t
val pp : Caml.Format.formatter -> M.t -> unit
OCaml

Innovation. Community. Security.