package core_kernel

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

Parameters

Signature

include sig ... end
include Comparable.S with type t := Tuple.Make(S1)(S2).t
include Base.Comparable_intf.S with type t := Tuple.Make(S1)(S2).t
include Base.Comparable_intf.Polymorphic_compare with type t := Tuple.Make(S1)(S2).t
include Base.Polymorphic_compare_intf.Infix with type t := Tuple.Make(S1)(S2).t

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

val ascending : Tuple.Make(S1)(S2).t -> Tuple.Make(S1)(S2).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 : Tuple.Make(S1)(S2).t -> Tuple.Make(S1)(S2).t -> int

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).

include Base.Comparator.S with type t := Tuple.Make(S1)(S2).t
type comparator_witness
include Base.Comparable_intf.Validate with type t := Tuple.Make(S1)(S2).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