package coq

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

The following three functions are similar to the ones defined in Inductive, but they expect an env

val type_of_inductive : Environ.env -> Constr.pinductive -> Constr.types
val type_of_constructor : Environ.env -> Constr.pconstructor -> Constr.types

Return type as quoted by the user

val type_of_constructors : Environ.env -> Constr.pinductive -> Constr.types array
val arities_of_constructors : Environ.env -> Constr.pinductive -> Constr.types array

Return constructor types in normal form

type inductive_family

An inductive type with its parameters (transparently supports reasoning either with only recursively uniform parameters or with all parameters including the recursively non-uniform ones

val liftn_inductive_family : int -> int -> inductive_family -> inductive_family
val lift_inductive_family : int -> inductive_family -> inductive_family
val substnl_ind_family : Constr.constr list -> int -> inductive_family -> inductive_family
val relevance_of_inductive_family : Environ.env -> inductive_family -> Sorts.relevance
type inductive_type =
  1. | IndType of inductive_family * EConstr.constr list

An inductive type with its parameters and real arguments

val make_ind_type : (inductive_family * EConstr.constr list) -> inductive_type
val dest_ind_type : inductive_type -> inductive_family * EConstr.constr list
val map_inductive_type : (EConstr.constr -> EConstr.constr) -> inductive_type -> inductive_type
val liftn_inductive_type : int -> int -> inductive_type -> inductive_type
val lift_inductive_type : int -> inductive_type -> inductive_type
val substnl_ind_type : EConstr.constr list -> int -> inductive_type -> inductive_type
val ind_of_ind_type : inductive_type -> Names.inductive
val relevance_of_inductive_type : Environ.env -> inductive_type -> Sorts.relevance
val mkAppliedInd : inductive_type -> EConstr.constr
val mis_is_recursive_subset : int list -> Declarations.wf_paths -> bool
Extract information from an inductive name
val nconstructors : Environ.env -> Names.inductive -> int
  • returns

    number of constructors

val nconstructors_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.nconstructors
val constructors_nrealargs : Environ.env -> Names.inductive -> int array
  • returns

    arity of constructors excluding parameters, excluding local defs

val constructors_nrealargs_env : Environ.env -> Names.inductive -> int array
  • deprecated Alias for Inductiveops.constructors_nrealargs
val constructors_nrealdecls : Environ.env -> Names.inductive -> int array
  • returns

    arity of constructors excluding parameters, including local defs

val constructors_nrealdecls_env : Environ.env -> Names.inductive -> int array
  • deprecated Alias for Inductiveops.constructors_nrealdecls
val inductive_nrealargs : Environ.env -> Names.inductive -> int
  • returns

    the arity, excluding params, excluding local defs

val inductive_nrealargs_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.inductive_nrealargs
val inductive_nrealdecls : Environ.env -> Names.inductive -> int
  • returns

    the arity, excluding params, including local defs

val inductive_nrealdecls_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.inductive_nrealdecls
val inductive_nallargs : Environ.env -> Names.inductive -> int
  • returns

    the arity, including params, excluding local defs

val inductive_nallargs_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.inductive_nallargs
val inductive_nalldecls : Environ.env -> Names.inductive -> int
  • returns

    the arity, including params, including local defs

val inductive_nalldecls_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.inductive_nalldecls
val inductive_nparams : Environ.env -> Names.inductive -> int
  • returns

    nb of params without local defs

val inductive_nparams_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.inductive_nparams
val inductive_nparamdecls : Environ.env -> Names.inductive -> int
  • returns

    nb of params with local defs

val inductive_nparamdecls_env : Environ.env -> Names.inductive -> int
  • deprecated Alias for Inductiveops.inductive_nparamsdecls
val inductive_paramdecls : Environ.env -> Constr.pinductive -> Constr.rel_context
  • returns

    params context

val inductive_paramdecls_env : Environ.env -> Constr.pinductive -> Constr.rel_context
  • deprecated Alias for Inductiveops.inductive_paramsdecl
val inductive_alldecls : Environ.env -> Constr.pinductive -> Constr.rel_context
  • returns

    full arity context, hence with letin

val inductive_alldecls_env : Environ.env -> Constr.pinductive -> Constr.rel_context
  • deprecated Alias for Inductiveops.inductive_alldecls
Extract information from a constructor name
val constructor_nallargs : Environ.env -> Names.constructor -> int
  • returns

    param + args without letin

val constructor_nallargs_env : Environ.env -> Names.constructor -> int
  • deprecated Alias for Inductiveops.constructor_nallargs
val constructor_nalldecls : Environ.env -> Names.constructor -> int
  • returns

    param + args with letin

val constructor_nalldecls_env : Environ.env -> Names.constructor -> int
  • deprecated Alias for Inductiveops.constructor_nalldecls
val constructor_nrealargs : Environ.env -> Names.constructor -> int
  • returns

    args without letin

val constructor_nrealargs_env : Environ.env -> Names.constructor -> int
  • deprecated Alias for Inductiveops.constructor_nrealargs
val constructor_nrealdecls : Environ.env -> Names.constructor -> int
  • returns

    args with letin

val constructor_nrealdecls_env : Environ.env -> Names.constructor -> int
  • deprecated Alias for Inductiveops.constructor_nrealdecls
val inductive_alltags : Environ.env -> Names.inductive -> bool list
  • returns

    tags of all decls: true = assumption, false = letin

val constructor_alltags : Environ.env -> Names.constructor -> bool list
val constructor_has_local_defs : Environ.env -> Names.constructor -> bool

Is there local defs in params or args ?

val inductive_has_local_defs : Environ.env -> Names.inductive -> bool
val sorts_below : Sorts.family -> Sorts.family list
val top_allowed_sort : Environ.env -> Names.inductive -> Sorts.family
val has_dependent_elim : Declarations.mutual_inductive_body -> bool

(Co)Inductive records with primitive projections do not have eta-conversion, hence no dependent elimination.

val type_of_projection_knowing_arg : Environ.env -> Evd.evar_map -> Names.Projection.t -> EConstr.t -> EConstr.types -> Constr.types

Primitive projections

Extract information from an inductive family

type constructor_summary = {
  1. cs_cstr : Constr.pconstructor;
  2. cs_params : Constr.constr list;
  3. cs_nargs : int;
  4. cs_args : Constr.rel_context;
  5. cs_concl_realargs : Constr.constr array;
}
val lift_constructor : int -> constructor_summary -> constructor_summary
val get_constructors : Environ.env -> inductive_family -> constructor_summary array

get_arity returns the arity of the inductive family instantiated with the parameters; if recursively non-uniform parameters are not part of the inductive family, they appears in the arity

val build_dependent_constructor : constructor_summary -> Constr.constr
val build_dependent_inductive : Environ.env -> inductive_family -> Constr.constr
val make_arity_signature : Environ.env -> Evd.evar_map -> bool -> inductive_family -> EConstr.rel_context
val make_arity : Environ.env -> Evd.evar_map -> bool -> inductive_family -> Sorts.t -> EConstr.types
val build_branch_type : Environ.env -> Evd.evar_map -> bool -> Constr.constr -> constructor_summary -> Constr.types

Raise Not_found if not given a valid inductive type

val arity_of_case_predicate : Environ.env -> inductive_family -> bool -> Sorts.t -> Constr.types

Builds the case predicate arity (dependent or not)

val type_case_branches_with_names : Environ.env -> Evd.evar_map -> (Constr.pinductive * EConstr.constr list) -> Constr.constr -> Constr.constr -> EConstr.types array * Constr.types

Annotation for cases

Make a case or substitute projections if the inductive type is a record with primitive projections. Fail with an error if the elimination is dependent while the inductive type does not allow dependent elimination.

Sometimes make_case_or_project is nicer to call with a pre-built case_invert than inductive_type.

val compute_projections : Environ.env -> Names.inductive -> (Constr.constr * Constr.types) array

Given a primitive record type, for every field computes the eta-expanded projection and its type.

val control_only_guard : Environ.env -> Evd.evar_map -> EConstr.types -> unit
OCaml

Innovation. Community. Security.