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 := T.t
include Hashtbl.HashedType with type t := T.t
val equal : T.t -> T.t -> bool

The equality predicate used to compare keys.

val hash : 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 Map.OrderedType with type t := T.t
val compare : T.t -> T.t -> int

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 print : Format.formatter -> T.t -> unit
module Map : Flambda2_algorithms.Container_types_intf.Map with type key = t and module Set = Set
type tag = t
val create_exn : int -> t
val to_int : t -> int
val zero : t
val string_tag : t
val closure_tag : t
val infix_tag : t
val double_tag : t
val double_array_tag : t
val custom_tag : t
val object_tag : t
val forward_tag : t
val lazy_tag : t
val is_structured_block : t -> bool

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

val is_structured_block_but_not_data_constructor : 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