jon.recoil.org

Module Global_module.Name

type t = private {
  1. head : string;
  2. args : Global_module.Name.argument list;
}
include Identifiable.S with type t := Global_module.Name.t
include Identifiable.Thing with type t := Global_module.Name.T.t
include Stdlib.Hashtbl.HashedType with type t := Global_module.Name.T.t

The equality predicate used to compare keys.

val hash : Global_module.Name.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 := Global_module.Name.T.t

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.

module Set : Identifiable.Set with module T := Global_module.Name.T
module Map : Identifiable.Map with module T := Global_module.Name.T
module Tbl : Identifiable.Tbl with module T := Global_module.Name.T
val create_exn : string -> Global_module.Name.argument list -> Global_module.Name.t
val create_no_args : string -> Global_module.Name.t
val to_string : Global_module.Name.t -> string
val find_in_parameter_map : Global_module.Name.t -> 'a Global_module.Parameter_name.Map.t -> 'a option
val mem_parameter_set : Global_module.Name.t -> Global_module.Parameter_name.Set.t -> bool