Module `Flambda2_identifiers.Name`

The sum type holding a Variable or a Symbol. The injection functions into the sum type are the identity.

include module type of struct include Int_ids.Name end

type t = private Flambda2_algorithms.Table_by_int_id.Id.t

include Flambda2_algorithms.Container_types.S_plus_iterator with type t := t

module T = Int_ids.Name.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 Set = Int_ids.Name.Set

module Map = Int_ids.Name.Map

val var : Int_ids.Variable.t -> t

val var_set : Int_ids.Variable.Set.t -> Set.t

val var_map : 'a Int_ids.Variable.Map.t -> 'a Map.t

val symbol : Int_ids.Symbol.t -> t

val pattern_match : 
  t ->
  var:(Int_ids.Variable.t -> 'a) ->
  symbol:(Int_ids.Symbol.t -> 'a) ->
  'a

val set_of_var_set : Flambda2_identifiers.Variable.Set.t -> Set.t

val set_of_symbol_set : Flambda2_identifiers.Symbol.Set.t -> Set.t

val set_to_var_set : Set.t -> Flambda2_identifiers.Variable.Set.t

val set_to_symbol_set : Set.t -> Flambda2_identifiers.Symbol.Set.t

val is_var : t -> bool

val is_symbol : t -> bool

val must_be_symbol : t -> Symbol.t

val compilation_unit : t -> Compilation_unit.t

val is_imported : t -> bool

val must_be_var_opt : t -> Variable.t option

val must_be_symbol_opt : t -> Symbol.t option

module Pair : sig ... end

Module Flambda2_identifiers.Name

Module `Flambda2_identifiers.Name`