package regular

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

creates a module implementing Opaque interface.

Parameters

module M : sig ... end

Signature

include Core_kernel.Std.Comparable.S 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 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 Core_kernel.Std.Hashable.S with type t := M.t
include Core_kernel.Hashable.Common with type t := M.t
val hash : M.t -> Base.Int.t
val compare : M.t -> M.t -> Base.Int.t
module Hash_set : Core_kernel.Hash_set.S with type elt = M.t
OCaml

Innovation. Community. Security.