Module Core_kernel.Flags.Make

Flags.Make builds a new flags module. If there is an error in the known flags, it behaves as per on_error.

We expose type t = int in the result of Flags.Make so that one can easily use flag constants as values of the flag type without having to coerce them. It is typical to hide the t = int in another signature S.

Parameters

M : Make_arg

Signature

type t = Int63.t
include sig ... end
val t_of_sexp : Base.Sexp.t ‑> t
val sexp_of_t : t ‑> Base.Sexp.t
val typerep_of_t : t Typerep_lib.Std.Typerep.t
val typename_of_t : t Typerep_lib.Std.Typename.t

consistent with subset

include Comparable.S with type t := t
include Core_kernel__.Comparable_intf.S_common
include Base.Comparable.S
include Base__.Comparable_intf.Polymorphic_compare
include Base.Comparisons.Infix
type t
val (>=) : t ‑> t ‑> bool
val (<=) : t ‑> t ‑> bool
val (=) : t ‑> t ‑> bool
val (>) : t ‑> t ‑> bool
val (<) : t ‑> t ‑> bool
val (<>) : t ‑> t ‑> bool
val equal : t ‑> t ‑> bool
val compare : 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
val max : t ‑> t ‑> t
val ascending : 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 ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t ‑> t ‑> int
val between : t ‑> low:t ‑> high:t ‑> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t ‑> min:t ‑> max: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 ‑> min:t ‑> max:t ‑> t Base.Or_error.t
include Base.Comparator.S with type t := t
type t
type comparator_witness
include Base__.Comparable_intf.Validate with type t := t
type t
val validate_lbound : min:t Base.Maybe_bound.t ‑> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t ‑> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t ‑> max:t Base.Maybe_bound.t ‑> t Base.Validate.check
module Map : Map.S with type Key.t = t with type Key.comparator_witness = comparator_witness
module Set : Set.S with type Elt.t = t with type Elt.comparator_witness = comparator_witness
val of_int : Core_kernel__.Import.int ‑> t
val to_int_exn : t ‑> Core_kernel__.Import.int
val empty : t
val (+) : t ‑> t ‑> t

set union, bitwise or

val (-) : t ‑> t ‑> t

set difference

val intersect : t ‑> t ‑> t

bitwise and

val complement : t ‑> t

bitwise not

val is_empty : t ‑> Core_kernel__.Import.bool
val do_intersect : t ‑> t ‑> Core_kernel__.Import.bool
val are_disjoint : t ‑> t ‑> Core_kernel__.Import.bool
val is_subset : t ‑> of_:t ‑> Core_kernel__.Import.bool

is_subset t ~of_ is t = intersect t of_