Module Flambda2_nominal.Name_mode

The modalities of names, which describe the different contexts in which names may occur.

type t = private
  1. | Normal
  2. | Phantom
  3. | In_types
type name_mode = t
val normal : t

Normal variables bind values that exist at runtime.

val in_types : t

In-types variables, sometimes known as irrelevant variables, are those that exist only within the environments and judgements of the Flambda 2 type system. There is no runtime value associated with an in-types variable.

val phantom : t

Phantom variables bind terms that are used for the generation of debugging information. There is no runtime value associated with a phantom variable.

val is_normal : t -> bool
val is_phantom : t -> bool
val is_in_types : t -> bool
val can_be_in_terms : t -> bool
val join_in_terms : t -> t -> t

join_in_terms must not be applied to the in-types mode.

include Flambda2_algorithms.Container_types.S 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 print : Format.formatter -> T.t -> unit
module Map : Flambda2_algorithms.Container_types_intf.Map with type key = t and module Set = Set
val compare_total_order : t -> t -> int
val compare_partial_order : t -> t -> int option
val compare : t -> t -> [ `Be_explicit_about_total_or_partial_ordering ]

This shadows compare from the above include.

module Or_absent : sig ... end