package core_kernel

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

Parameters

module T : sig ... end

Signature

include Base.Comparable_intf.S with type t := T.t
include Base.Comparable_intf.Polymorphic_compare with type t := T.t
include Base.Comparisons.Infix with type t := T.t
val (>=) : T.t -> T.t -> bool
val (<=) : T.t -> T.t -> bool
val (=) : T.t -> T.t -> bool
val (>) : T.t -> T.t -> bool
val (<) : T.t -> T.t -> bool
val (<>) : T.t -> T.t -> bool
val equal : T.t -> T.t -> bool
val compare : T.t -> T.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 : T.t -> T.t -> T.t
val max : T.t -> T.t -> T.t
val ascending : T.t -> T.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 : T.t -> T.t -> int
val between : T.t -> low:T.t -> high:T.t -> bool
val clamp_exn : T.t -> min:T.t -> max:T.t -> T.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 : T.t -> min:T.t -> max:T.t -> T.t Base.Or_error.t
include Base.Comparator.S with type t := T.t
type comparator_witness
include Base.Comparable_intf.Validate with type t := T.t
val validate_lbound : min:T.t Base.Maybe_bound.t -> T.t Base.Validate.check
val validate_ubound : max:T.t Base.Maybe_bound.t -> T.t Base.Validate.check
module Map : Map.S with type Key.t = T.t with type Key.comparator_witness = comparator_witness
module Set : Set.S with type Elt.t = T.t with type Elt.comparator_witness = comparator_witness
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