jon.recoil.org

Module Flambda2_kinds.Tag

Tags on OCaml values.

include Flambda2_algorithms.Container_types.S
type t
include Flambda2_algorithms.Container_types_intf.Thing with type t := Flambda2_kinds.Tag.T.t
include Stdlib.Hashtbl.HashedType with type t := Flambda2_kinds.Tag.T.t

The equality predicate used to compare keys.

val hash : Flambda2_kinds.Tag.T.t -> int

A hashing function on keys. It must be such that if two keys are equal according to equal, then they have identical hash values as computed by hash. Examples: suitable (equal, hash) pairs for arbitrary key types include

  • ((=), hash) for comparing objects by structure (provided objects do not contain floats)
  • ((fun x y -> compare x y = 0), hash) for comparing objects by structure and handling Stdlib.nan correctly
  • ((==), hash) for comparing objects by physical equality (e.g. for mutable or cyclic objects).
include Stdlib.Map.OrderedType with type t := Flambda2_kinds.Tag.T.t

A total ordering function over the keys. This is a two-argument function f such that f e1 e2 is zero if the keys e1 and e2 are equal, f e1 e2 is strictly negative if e1 is smaller than e2, and f e1 e2 is strictly positive if e1 is greater than e2. Example: a suitable ordering function is the generic structural comparison function Stdlib.compare.

val create_exn : int -> Flambda2_kinds.Tag.t
val to_int : Flambda2_kinds.Tag.t -> int
val string_tag : Flambda2_kinds.Tag.t
val closure_tag : Flambda2_kinds.Tag.t
val infix_tag : Flambda2_kinds.Tag.t
val double_tag : Flambda2_kinds.Tag.t
val double_array_tag : Flambda2_kinds.Tag.t
val custom_tag : Flambda2_kinds.Tag.t
val object_tag : Flambda2_kinds.Tag.t
val forward_tag : Flambda2_kinds.Tag.t
val lazy_tag : Flambda2_kinds.Tag.t
val is_structured_block : Flambda2_kinds.Tag.t -> bool

Returns true iff the supplied tag is that of a GC-scannable block.

val is_structured_block_but_not_data_constructor : Flambda2_kinds.Tag.t -> bool

Returns true iff the supplied tag is that of a GC-scannable block, but outside the range of data constructors (or arrays, records, etc.), for example a lazy value.

module Scannable : sig ... end
module Non_scannable : sig ... end