jon.recoil.org

Module Is_parameter

Whether a variable is a local or a function parameter.

type t = private
  1. | Local
  2. | Parameter of {
    1. index : int;
    }
val local : Is_parameter.t
val parameter : index:int -> Is_parameter.t
include Identifiable.S with type t := Is_parameter.t
module T : Identifiable.Thing with type t = Is_parameter.t
include Identifiable.Thing with type t := Is_parameter.T.t
include Stdlib.Hashtbl.HashedType with type t := Is_parameter.T.t
val equal : Is_parameter.T.t -> Is_parameter.T.t -> bool

The equality predicate used to compare keys.

val hash : Is_parameter.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 := Is_parameter.T.t
val compare : Is_parameter.T.t -> Is_parameter.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 output : Stdlib.out_channel -> Is_parameter.T.t -> unit
module Set : Identifiable.Set with module T := Is_parameter.T
module Map : Identifiable.Map with module T := Is_parameter.T
module Tbl : Identifiable.Tbl with module T := Is_parameter.T