Module `Flambda2_kinds.Flambda_kind`

Kinds and subkinds of Flambda types.

module Naked_number_kind : sig ... end

type t = private

| Value
(*
OCaml values, either immediates or pointers.
*)
| Naked_number of Flambda2_kinds.Flambda_kind.Naked_number_kind.t
(*
The kind of unboxed numbers and untagged immediates.
*)
| Region
(*
Values which have been introduced by Flambda and are never accessible at the source language level (for example sets of closures).
*)
| Rec_info
(*
Recursion depths of identifiers. Like Region, not accessible at the source level, but also not accessible at run time.
*)

The kinds themselves.

type kind = Flambda2_kinds.Flambda_kind.t

val value : Flambda2_kinds.Flambda_kind.t

Constructors for the various kinds.

val naked_number : 
  Flambda2_kinds.Flambda_kind.Naked_number_kind.t ->
  Flambda2_kinds.Flambda_kind.t

val naked_immediate : Flambda2_kinds.Flambda_kind.t

val naked_float32 : Flambda2_kinds.Flambda_kind.t

val naked_float : Flambda2_kinds.Flambda_kind.t

val naked_int8 : Flambda2_kinds.Flambda_kind.t

val naked_int16 : Flambda2_kinds.Flambda_kind.t

val naked_int32 : Flambda2_kinds.Flambda_kind.t

val naked_int64 : Flambda2_kinds.Flambda_kind.t

val naked_nativeint : Flambda2_kinds.Flambda_kind.t

val naked_vec128 : Flambda2_kinds.Flambda_kind.t

val naked_vec256 : Flambda2_kinds.Flambda_kind.t

val naked_vec512 : Flambda2_kinds.Flambda_kind.t

val region : Flambda2_kinds.Flambda_kind.t

val rec_info : Flambda2_kinds.Flambda_kind.t

val is_value : Flambda2_kinds.Flambda_kind.t -> bool

val is_naked_float : Flambda2_kinds.Flambda_kind.t -> bool

include Flambda2_algorithms.Container_types.S
  with type t := Flambda2_kinds.Flambda_kind.t

module T : 
  Flambda2_algorithms.Container_types_intf.Thing
    with type t = Flambda2_kinds.Flambda_kind.t

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

include Stdlib.Hashtbl.HashedType
  with type t := Flambda2_kinds.Flambda_kind.T.t

val equal : 
  Flambda2_kinds.Flambda_kind.T.t ->
  Flambda2_kinds.Flambda_kind.T.t ->
  bool

The equality predicate used to compare keys.

val hash : Flambda2_kinds.Flambda_kind.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_kinds.Flambda_kind.T.t

val compare : 
  Flambda2_kinds.Flambda_kind.T.t ->
  Flambda2_kinds.Flambda_kind.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 -> Flambda2_kinds.Flambda_kind.T.t -> unit

module Set : 
  Flambda2_algorithms.Container_types_intf.Set
    with type elt = Flambda2_kinds.Flambda_kind.t

module Map : 
  Flambda2_algorithms.Container_types_intf.Map
    with type key = Flambda2_kinds.Flambda_kind.t
     and module Set = Flambda2_kinds.Flambda_kind.Set

type flat_suffix_element = private

| Naked_float
| Naked_float32
| Naked_int8
| Naked_int16
| Naked_int32
| Naked_int64
| Naked_nativeint
| Naked_immediate
| Naked_vec128
| Naked_vec256
| Naked_vec512

module Mixed_block_lambda_shape = Mixed_block_shape

module Mixed_block_shape : sig ... end

module Scannable_block_shape : sig ... end

module Block_shape : sig ... end

module Standard_int : sig ... end

module Boxable_number : sig ... end

These kinds are those of the numbers for which a tailored boxed representation exists.

module With_subkind : sig ... end

module Flat_suffix_element : sig ... end

module Standard_int_or_float : sig ... end

Module Flambda2_kinds.Flambda_kind

Module `Flambda2_kinds.Flambda_kind`