package coq-core

  1. Overview
  2. Docs
package coq-core
Legend:
Library
Module
Module type
Parameter
Class
Class type

This file defines universe unification states which are part of evarmaps. Most of the API below is reexported in Evd. Consider using higher-level primitives when needed.

type universes_entry =
  1. | Monomorphic_entry of Univ.ContextSet.t
  2. | Polymorphic_entry of UVars.UContext.t
exception UniversesDiffer
type t

Type of universe unification states. They allow the incremental building of universe constraints during an interactive proof.

Constructors

Different ways to create a new universe state

val empty : t
val make : lbound:UGraph.Bound.t -> UGraph.t -> t
  • deprecated Use from_env
val make_with_initial_binders : lbound:UGraph.Bound.t -> UGraph.t -> Names.lident list -> t
  • deprecated Use from_env
val from_env : ?binders:Names.lident list -> Environ.env -> t

Main entry point at the beginning of a declaration declaring the binding names as rigid universes.

Main entry point when only names matter, e.g. for printing.

val of_context_set : UnivGen.sort_context_set -> t

Main entry point when starting from the instance of a global reference, e.g. when building a scheme.

Misc

val is_empty : t -> bool
val union : t -> t -> t
Projections and other destructors
val context_set : t -> Univ.ContextSet.t

The local context of the state, i.e. a set of bound variables together with their associated constraints.

val sort_context_set : t -> UnivGen.sort_context_set
type universe_opt_subst = UnivFlex.t
val subst : t -> UnivFlex.t

The local universes that are unification variables

val nf_universes : t -> Constr.t -> Constr.t

Apply the local substitution subst

val ugraph : t -> UGraph.t

The current graph extended with the local constraints

val initial_graph : t -> UGraph.t

The initial graph with just the declarations of new universes.

val is_algebraic : Univ.Level.t -> t -> bool

Can this universe be instantiated with an algebraic universe (ie it appears in inferred types only).

val constraints : t -> Univ.Constraints.t

Shorthand for context_set composed with ContextSet.constraints.

val context : t -> UVars.UContext.t

Shorthand for context_set with Context_set.to_context.

type named_universes_entry = universes_entry * UnivNames.universe_binders
val univ_entry : poly:bool -> t -> named_universes_entry

Pick from context or context_set based on poly.

val universe_binders : t -> UnivNames.universe_binders

Return local names of universes.

val nf_qvar : t -> Sorts.QVar.t -> Sorts.Quality.t

Returns the normal form of the sort variable.

val nf_quality : t -> Sorts.Quality.t -> Sorts.Quality.t
val nf_instance : t -> UVars.Instance.t -> UVars.Instance.t
val nf_level : t -> Univ.Level.t -> Univ.Level.t

Must not be allowed to be algebraic

val nf_universe : t -> Univ.Universe.t -> Univ.Universe.t
val nf_sort : t -> Sorts.t -> Sorts.t

Returns the normal form of the sort.

val nf_relevance : t -> Sorts.relevance -> Sorts.relevance

Returns the normal form of the relevance.

Constraints handling
val add_constraints : t -> Univ.Constraints.t -> t
val add_universe_constraints : t -> UnivProblem.Set.t -> t
val check_qconstraints : t -> Sorts.QConstraints.t -> bool
val check_universe_constraints : t -> UnivProblem.Set.t -> bool
val add_quconstraints : t -> Sorts.QUConstraints.t -> t
Names
val quality_of_name : t -> Names.Id.t -> Sorts.QVar.t
val universe_of_name : t -> Names.Id.t -> Univ.Level.t

Retrieve the universe associated to the name.

val name_level : Univ.Level.t -> Names.Id.t -> t -> t

Gives a name to the level (making it a binder). Asserts the name is not already used by a level

Unification
val restrict_universe_context : lbound:UGraph.Bound.t -> Univ.ContextSet.t -> Univ.Level.Set.t -> Univ.ContextSet.t

restrict_universe_context lbound (univs,csts) keep restricts univs to the universes in keep. The constraints csts are adjusted so that transitive constraints between remaining universes (those in keep and those not in univs) are preserved.

val restrict : t -> Univ.Level.Set.t -> t

restrict uctx ctx restricts the local universes of uctx to ctx extended by local named universes and side effect universes (from demote_seff_univs). Transitive constraints between retained universes are preserved.

val restrict_even_binders : t -> Univ.Level.Set.t -> t

restrict_even_binders uctx ctx restricts the local universes of uctx to ctx extended by side effect universes (from demote_seff_univs). Transitive constraints between retained universes are preserved.

type rigid =
  1. | UnivRigid
  2. | UnivFlexible of bool
    (*

    Is substitution by an algebraic ok?

    *)
val univ_rigid : rigid
val univ_flexible : rigid
val univ_flexible_alg : rigid
val merge : ?loc:Loc.t -> sideff:bool -> rigid -> t -> Univ.ContextSet.t -> t
val merge_sort_variables : ?loc:Loc.t -> sideff:bool -> t -> Sorts.QVar.Set.t -> t
val merge_sort_context : ?loc:Loc.t -> sideff:bool -> rigid -> t -> UnivGen.sort_context_set -> t
val emit_side_effects : Safe_typing.private_constants -> t -> t
val demote_global_univs : Environ.env -> t -> t

Removes from the uctx_local part of the UState the universes and constraints that are present in the universe graph in the input env (supposedly the global ones)

val demote_seff_univs : Univ.Level.Set.t -> t -> t

Mark the universes as not local any more, because they have been globally declared by some side effect. You should be using emit_side_effects instead.

val new_sort_variable : ?loc:Loc.t -> ?name:Names.Id.t -> t -> t * Sorts.QVar.t

Declare a new local sort.

val new_univ_variable : ?loc:Loc.t -> rigid -> Names.Id.t option -> t -> t * Univ.Level.t

Declare a new local universe; use rigid if a global or bound universe; use flexible for a universe existential variable; use univ_flexible_alg for a universe existential variable allowed to be instantiated with an algebraic universe

val add_global_univ : t -> Univ.Level.t -> t
val make_nonalgebraic_variable : t -> Univ.Level.t -> t

cf UnivFlex

val make_flexible_nonalgebraic : t -> t

cf UnivFlex

val normalize_variables : t -> t
val constrain_variables : Univ.Level.Set.t -> t -> t
val fix_undefined_variables : t -> t

cf UnivFlex

val minimize : t -> t

Universe minimization

val collapse_sort_variables : t -> t
type ('a, 'b, 'c) gen_universe_decl = {
  1. univdecl_qualities : 'a;
  2. univdecl_instance : 'b;
  3. univdecl_extensible_instance : bool;
  4. univdecl_constraints : 'c;
  5. univdecl_extensible_constraints : bool;
}
val default_univ_decl : universe_decl
val check_univ_decl : poly:bool -> t -> universe_decl -> named_universes_entry

check_univ_decl ctx decl

If non extensible in decl, check that the local universes (resp. universe constraints) in ctx are implied by decl.

Return a universes_entry containing the local universes of ctx and their constraints.

When polymorphic, the universes corresponding to decl.univdecl_instance come first in the order defined by that list.

val check_mono_univ_decl : t -> universe_decl -> Univ.ContextSet.t
TODO: Document me
val update_sigma_univs : t -> UGraph.t -> t
Pretty-printing
val pr_uctx_level : t -> Univ.Level.t -> Pp.t
val pr_uctx_qvar : t -> Sorts.QVar.t -> Pp.t
val qualid_of_level : t -> Univ.Level.t -> Libnames.qualid option
val id_of_level : t -> Univ.Level.t -> Names.Id.t option

Only looks in the local names, not in the nametab.

val id_of_qvar : t -> Sorts.QVar.t -> Names.Id.t option
val pr_weak : (Univ.Level.t -> Pp.t) -> t -> Pp.t
val pr_sort_opt_subst : t -> Pp.t
module Internal : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct