Module `Tag.Scannable`

type t

Tags that are strictly less than No_scan_tag, corresponding to blocks with fields that can be scanned by the GC.

val create_exn : int -> Flambda2_kinds.Tag.Scannable.t

Raises not only if the supplied integer is less than 0 but also if it is greater than or equal to No_scan_tag.

val create : int -> Flambda2_kinds.Tag.Scannable.t option

val of_tag : Flambda2_kinds.Tag.tag -> Flambda2_kinds.Tag.Scannable.t option

val to_int : Flambda2_kinds.Tag.Scannable.t -> int

val to_targetint : 
  Target_system.Machine_width.t ->
  Flambda2_kinds.Tag.Scannable.t ->
  Flambda2_numbers.Targetint_32_64.t

val to_tag : Flambda2_kinds.Tag.Scannable.t -> Flambda2_kinds.Tag.tag

val zero : Flambda2_kinds.Tag.Scannable.t

val object_tag : Flambda2_kinds.Tag.Scannable.t

include Flambda2_algorithms.Container_types.S
  with type t := Flambda2_kinds.Tag.Scannable.t

module T : 
  Flambda2_algorithms.Container_types_intf.Thing
    with type t = Flambda2_kinds.Tag.Scannable.t

include Flambda2_algorithms.Container_types_intf.Thing
  with type t := Flambda2_kinds.Tag.Scannable.T.t

include Stdlib.Hashtbl.HashedType
  with type t := Flambda2_kinds.Tag.Scannable.T.t

val equal : 
  Flambda2_kinds.Tag.Scannable.T.t ->
  Flambda2_kinds.Tag.Scannable.T.t ->
  bool

The equality predicate used to compare keys.

val hash : Flambda2_kinds.Tag.Scannable.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.Scannable.T.t

val compare : 
  Flambda2_kinds.Tag.Scannable.T.t ->
  Flambda2_kinds.Tag.Scannable.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 : Stdlib.Format.formatter -> Flambda2_kinds.Tag.Scannable.T.t -> unit

module Set : 
  Flambda2_algorithms.Container_types_intf.Set
    with type elt = Flambda2_kinds.Tag.Scannable.t

module Map : 
  Flambda2_algorithms.Container_types_intf.Map
    with type key = Flambda2_kinds.Tag.Scannable.t
     and module Set = Flambda2_kinds.Tag.Scannable.Set

Module Tag.Scannable

Module `Tag.Scannable`