Module `Flambda2_identifiers.Value_slot`

A label, unique across the whole program, that identifies the value of a captured variable in a set of closures. Value slots are assigned integer offsets inside Closure_tag blocks, where the relevant captured value will be stored at runtime, by the Slot_offsets module.

include Flambda2_identifiers.Slot.S

include Flambda2_algorithms.Container_types.S

type t

module T : 
  Flambda2_algorithms.Container_types_intf.Thing
    with type t = Flambda2_identifiers.Value_slot.t

include Flambda2_algorithms.Container_types_intf.Thing
  with type t := Flambda2_identifiers.Value_slot.T.t

include Stdlib.Hashtbl.HashedType
  with type t := Flambda2_identifiers.Value_slot.T.t

val equal : 
  Flambda2_identifiers.Value_slot.T.t ->
  Flambda2_identifiers.Value_slot.T.t ->
  bool

The equality predicate used to compare keys.

val hash : Flambda2_identifiers.Value_slot.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_identifiers.Value_slot.T.t

val compare : 
  Flambda2_identifiers.Value_slot.T.t ->
  Flambda2_identifiers.Value_slot.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_identifiers.Value_slot.T.t ->
  unit

module Set : 
  Flambda2_algorithms.Container_types_intf.Set
    with type elt = Flambda2_identifiers.Value_slot.t

module Map : 
  Flambda2_algorithms.Container_types_intf.Map
    with type key = Flambda2_identifiers.Value_slot.t
     and module Set = Flambda2_identifiers.Value_slot.Set

module Lmap : 
  Flambda2_algorithms.Lmap.S with type key = Flambda2_identifiers.Value_slot.t

val create : 
  Compilation_unit.t ->
  name:string ->
  is_always_immediate:bool ->
  Flambda2_kinds.Flambda_kind.t ->
  Flambda2_identifiers.Value_slot.t

val get_compilation_unit : 
  Flambda2_identifiers.Value_slot.t ->
  Compilation_unit.t

val in_compilation_unit : 
  Flambda2_identifiers.Value_slot.t ->
  Compilation_unit.t ->
  bool

val is_imported : Flambda2_identifiers.Value_slot.t -> bool

val to_string : Flambda2_identifiers.Value_slot.t -> string

val name : Flambda2_identifiers.Value_slot.t -> string

val kind : Flambda2_identifiers.Value_slot.t -> Flambda2_kinds.Flambda_kind.t

val is_always_immediate : Flambda2_identifiers.Value_slot.t -> bool

val rename : 
  Flambda2_identifiers.Value_slot.t ->
  Flambda2_identifiers.Value_slot.t

Module Flambda2_identifiers.Value_slot

Module `Flambda2_identifiers.Value_slot`