package core_kernel
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=fd2b8c6715794df7a810a62b226f53720f211cd344b4afc9fab0498796d6b466
doc/core_kernel.flags/Flags/Make_binable/index.html
Module Flags.Make_binable
Source
Similar to Flags.Make
, but the resulting type t
is binable.
Parameters
Signature
include Core.Bin_prot.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
This function only needs implementation if t
exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t
afterwards.
consistent with subset
include Core.Comparable.S with type t := t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
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
.
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.
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)
.
module Map :
Core.Map.S
with type Key.t = t
with type Key.comparator_witness = comparator_witness
module Set :
Core.Set.S
with type Elt.t = t
with type Elt.comparator_witness = comparator_witness
set difference. Although we use operators +
and -
, they do not satisfy the usual arithmetic equations, e.g. x - y = x + (empty - y)
does not hold.