package regular

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

creates a module implementing Opaque interface.

Parameters

module M : sig ... end

Signature

include Core_kernel.Comparable.S with type t := M.t
include Base.Comparable.S with type t := M.t
include Base.Comparisons.S with type t := M.t
include Base.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 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 Base.Or_error.t
include Base.Comparator.S with type t := M.t
type comparator_witness
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.Hashable.S with type t := M.t
include Core_kernel.Hashable.Common with type t := M.t
val compare : M.t -> M.t -> Base.Int.t
val hash_fold_t : Base.Hash.state -> M.t -> Base.Hash.state
val hashable : M.t Base.Hashable.t
module Table : Core_kernel.Hashtbl.S with type key = M.t
module Hash_set : Core_kernel.Hash_set.S with type elt = M.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct