package base

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

Inherit comparability from a component.

Parameters

module C : sig ... end
module T : sig ... end

Signature

include Comparable_intf.Polymorphic_compare with type t := T.t
include Polymorphic_compare_intf.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

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

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 Or_error.t
include Comparator.S with type t := T.t
type comparator_witness
include Comparable_intf.Validate with type t := T.t
val validate_lbound : min:T.t Maybe_bound.t -> T.t Validate.check
val validate_ubound : max:T.t Maybe_bound.t -> T.t Validate.check
val validate_bound : min:T.t Maybe_bound.t -> max:T.t Maybe_bound.t -> T.t Validate.check
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