jon.recoil.org

Module Flambda2_identifiers.Reg_width_const

Constants that fit in registers on the target machine.

include module type of struct include Int_ids.Const end
type exported = Int_ids.Const.exported
include Flambda2_algorithms.Container_types.S with type t := t
module T = Int_ids.Const.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.Const.Set
module Map = Int_ids.Const.Map
val const_true : Target_system.Machine_width.t -> t
val const_false : Target_system.Machine_width.t -> t
val untagged_const_true : Target_system.Machine_width.t -> t
val untagged_const_false : Target_system.Machine_width.t -> t
val untagged_const_zero : Target_system.Machine_width.t -> t
val untagged_const_int : Flambda2_numbers.Target_ocaml_int.t -> t
val const_zero : Target_system.Machine_width.t -> t
val const_one : Target_system.Machine_width.t -> t
val const_unit : Target_system.Machine_width.t -> t
val const_null : t
val naked_immediate : Flambda2_numbers.Target_ocaml_int.t -> t

naked_immediate is similar to naked_nativeint, but represents integers of width n - 1 bits, where n is the native machine width. (By contrast, naked_nativeint represents integers of width n bits.)

val tagged_immediate : Flambda2_numbers.Target_ocaml_int.t -> t
val naked_int32 : Int32.t -> t
val naked_int64 : Int64.t -> t
val naked_nativeint : Flambda2_numbers.Targetint_32_64.t -> t
module Descr = Int_ids.Const.Descr
val descr : t -> Descr.t
val export : t -> exported
val import : exported -> t
val of_descr : Descr.t -> t
val is_null : t -> bool
val is_naked_immediate : t -> Flambda2_numbers.Target_ocaml_int.t option
val is_tagged_immediate : t -> Flambda2_numbers.Target_ocaml_int.t option
val is_naked_int8 : t -> Flambda2_numbers.Numeric_types.Int8.t option
val is_naked_int16 : t -> Flambda2_numbers.Numeric_types.Int16.t option
val is_naked_int32 : t -> int32 option
val is_naked_int64 : t -> int64 option
val is_naked_nativeint : t -> Flambda2_numbers.Targetint_32_64.t option

Create a numeric constant of the given kind (Region and Rec_info are forbidden).