Module Flambda2_identifiers.Variable

include module type of struct include Int_ids.Variable end
include Flambda2_algorithms.Container_types.S_plus_iterator with type t := 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 Lmap = Int_ids.Variable.Lmap
val create : ?user_visible:unit -> string -> Flambda2_kinds.Flambda_kind.t -> t
val compilation_unit : t -> Compilation_unit.t
val name : t -> string
val name_stamp : t -> int
val user_visible : t -> bool
val export : t -> exported
val import : exported -> t
val create_with_same_name_as_ident : ?user_visible:unit -> Ident.t -> Flambda2_kinds.Flambda_kind.t -> t
val rename : ?append:string -> t -> t

rename always returns a variable with a compilation unit set to that of the current unit, not the unit of the variable passed in.

val is_renamed_version_of : t -> t -> bool
val unique_name : t -> string
val raw_name : t -> string