Module `Flambda2_term_basics.Simple`

A value that is known to fit into a register (of the appropriate kind) on the target machine. We do not require such values to be Let-bound.

include module type of struct include Flambda2_identifiers.Int_ids.Simple end

type t = private Flambda2_algorithms.Table_by_int_id.Id.t

type exported = Flambda2_identifiers.Int_ids.Simple.exported

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

module T = Flambda2_identifiers.Int_ids.Simple.T

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

include Stdlib.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 Stdlib.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 : Stdlib.Format.formatter -> T.t -> unit

module Set = Flambda2_identifiers.Int_ids.Simple.Set

module Map = Flambda2_identifiers.Int_ids.Simple.Map

val name : Flambda2_identifiers.Int_ids.Name.t -> Flambda2_term_basics.Simple.t

val var : 
  Flambda2_identifiers.Int_ids.Variable.t ->
  Flambda2_term_basics.Simple.t

val vars : 
  Flambda2_identifiers.Int_ids.Variable.t list ->
  Flambda2_term_basics.Simple.t list

val symbol : 
  Flambda2_identifiers.Int_ids.Symbol.t ->
  Flambda2_term_basics.Simple.t

val const : 
  Flambda2_identifiers.Int_ids.Const.t ->
  Flambda2_term_basics.Simple.t

val coercion : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_identifiers.Int_ids.Coercion.t

val with_coercion : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_identifiers.Int_ids.Coercion.t ->
  Flambda2_term_basics.Simple.t

val pattern_match : 
  Flambda2_term_basics.Simple.t ->
  name:
    (Flambda2_identifiers.Int_ids.Name.t ->
      coercion:Flambda2_identifiers.Int_ids.Coercion.t ->
      'a) ->
  const:(Flambda2_identifiers.Int_ids.Const.t -> 'a) ->
  'a

val same : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_term_basics.Simple.t ->
  bool

val export : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_term_basics.Simple.exported

val import : 
  Flambda2_term_basics.Simple.exported ->
  Flambda2_term_basics.Simple.t

include Flambda2_nominal.Contains_names.S
  with type t := Flambda2_term_basics.Simple.t

val free_names : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_nominal.Name_occurrences.t

Compute the free names of a term. Such computation covers all kinds of bindable names (variables, continuations, ...)

val apply_renaming : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_nominal.Renaming.t ->
  Flambda2_term_basics.Simple.t

Apply a renaming throughout a term.

val has_coercion : Flambda2_term_basics.Simple.t -> bool

val apply_coercion : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_term_basics.Coercion.t ->
  Flambda2_term_basics.Simple.t option

val apply_coercion_exn : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_term_basics.Coercion.t ->
  Flambda2_term_basics.Simple.t

val without_coercion : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_term_basics.Simple.t

val must_be_var : 
  Flambda2_term_basics.Simple.t ->
  (Flambda2_identifiers.Variable.t * Flambda2_term_basics.Coercion.t) option

val must_be_symbol : 
  Flambda2_term_basics.Simple.t ->
  (Flambda2_identifiers.Symbol.t * Flambda2_term_basics.Coercion.t) option

val must_be_name : 
  Flambda2_term_basics.Simple.t ->
  (Flambda2_identifiers.Name.t * Flambda2_term_basics.Coercion.t) option

val must_be_const : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_identifiers.Reg_width_const.t option

val const_int : 
  Flambda2_numbers.Target_ocaml_int.t ->
  Flambda2_term_basics.Simple.t

The constant representating the given number of type "int".

val const_bool : 
  Target_system.Machine_width.t ->
  bool ->
  Flambda2_term_basics.Simple.t

The constant representating the given boolean value.

val untagged_const_bool : 
  Target_system.Machine_width.t ->
  bool ->
  Flambda2_term_basics.Simple.t

The naked immediate constant representating the given boolean value.

val const_true : Target_system.Machine_width.t -> Flambda2_term_basics.Simple.t

The constant representating boolean true.

val untagged_const_true : 
  Target_system.Machine_width.t ->
  Flambda2_term_basics.Simple.t

val const_false : 
  Target_system.Machine_width.t ->
  Flambda2_term_basics.Simple.t

The constant representating boolean false.

val untagged_const_false : 
  Target_system.Machine_width.t ->
  Flambda2_term_basics.Simple.t

val const_zero : Target_system.Machine_width.t -> Flambda2_term_basics.Simple.t

The constant representating the number zero of type "int".

val untagged_const_zero : 
  Target_system.Machine_width.t ->
  Flambda2_term_basics.Simple.t

val untagged_const_int : 
  Flambda2_numbers.Target_ocaml_int.t ->
  Flambda2_term_basics.Simple.t

val const_one : Target_system.Machine_width.t -> Flambda2_term_basics.Simple.t

val const_unit : Target_system.Machine_width.t -> Flambda2_term_basics.Simple.t

The constant representing the unit value.

val const_from_descr : 
  Flambda2_identifiers.Reg_width_const.Descr.t ->
  Flambda2_term_basics.Simple.t

val const_int_of_kind : 
  machine_width:Target_system.Machine_width.t ->
  Flambda2_kinds.Flambda_kind.t ->
  int ->
  Flambda2_term_basics.Simple.t

val is_const : Flambda2_term_basics.Simple.t -> bool

val is_symbol : Flambda2_term_basics.Simple.t -> bool

val is_var : Flambda2_term_basics.Simple.t -> bool

val is_imported_or_constant : Flambda2_term_basics.Simple.t -> bool

val free_names_in_types : 
  Flambda2_term_basics.Simple.t ->
  Flambda2_nominal.Name_occurrences.t

val pattern_match' : 
  Flambda2_term_basics.Simple.t ->
  var:
    (Flambda2_identifiers.Variable.t ->
      coercion:Flambda2_term_basics.Coercion.t ->
      'a) ->
  symbol:
    (Flambda2_identifiers.Symbol.t ->
      coercion:Flambda2_term_basics.Coercion.t ->
      'a) ->
  const:(Flambda2_identifiers.Reg_width_const.t -> 'a) ->
  'a

val kind : Flambda2_term_basics.Simple.t -> Flambda2_kinds.Flambda_kind.t

module List : sig ... end

module With_kind : sig ... end

module With_debuginfo : sig ... end

Module Flambda2_term_basics.Simple

Module `Flambda2_term_basics.Simple`