Module `Flambda2_nominal.Name_mode`

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

type t = private

| Normal
| Phantom
| In_types

type name_mode = Flambda2_nominal.Name_mode.t

val normal : Flambda2_nominal.Name_mode.t

Normal variables bind values that exist at runtime.

val in_types : Flambda2_nominal.Name_mode.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 : Flambda2_nominal.Name_mode.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 : Flambda2_nominal.Name_mode.t -> bool

val is_phantom : Flambda2_nominal.Name_mode.t -> bool

val is_in_types : Flambda2_nominal.Name_mode.t -> bool

val can_be_in_terms : Flambda2_nominal.Name_mode.t -> bool

val join_in_terms : 
  Flambda2_nominal.Name_mode.t ->
  Flambda2_nominal.Name_mode.t ->
  Flambda2_nominal.Name_mode.t

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

include Flambda2_algorithms.Container_types.S
  with type t := Flambda2_nominal.Name_mode.t

module T : 
  Flambda2_algorithms.Container_types_intf.Thing
    with type t = Flambda2_nominal.Name_mode.t

include Flambda2_algorithms.Container_types_intf.Thing
  with type t := Flambda2_nominal.Name_mode.T.t

include Stdlib.Hashtbl.HashedType with type t := Flambda2_nominal.Name_mode.T.t

val equal : 
  Flambda2_nominal.Name_mode.T.t ->
  Flambda2_nominal.Name_mode.T.t ->
  bool

The equality predicate used to compare keys.

val hash : Flambda2_nominal.Name_mode.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_nominal.Name_mode.T.t

val print : Stdlib.Format.formatter -> Flambda2_nominal.Name_mode.T.t -> unit

module Set : 
  Flambda2_algorithms.Container_types_intf.Set
    with type elt = Flambda2_nominal.Name_mode.t

module Map : 
  Flambda2_algorithms.Container_types_intf.Map
    with type key = Flambda2_nominal.Name_mode.t
     and module Set = Flambda2_nominal.Name_mode.Set

val compare_total_order : 
  Flambda2_nominal.Name_mode.t ->
  Flambda2_nominal.Name_mode.t ->
  int

val compare_partial_order : 
  Flambda2_nominal.Name_mode.t ->
  Flambda2_nominal.Name_mode.t ->
  int option

val compare : 
  Flambda2_nominal.Name_mode.t ->
  Flambda2_nominal.Name_mode.t ->
  [ `Be_explicit_about_total_or_partial_ordering ]

This shadows compare from the above include.

module Or_absent : sig ... end

Module Flambda2_nominal.Name_mode

Module `Flambda2_nominal.Name_mode`