Definitions
===========

.. index:: let ... := ... (term)

.. _let-in:

Let-in definitions
------------------

.. insertprodn term_let term_let

.. prodn::
   term_let ::= let @name {? : @type } := @term in @term
   | let @name {+ @binder } {? : @type } := @term in @term
   | @destructuring_let

:n:`let @ident := @term__1 in @term__2` represents the local binding of
the variable :n:`@ident` to the value :n:`@term__1` in :n:`@term__2`.

:n:`let @ident {+ @binder} := @term__1 in @term__2` is an abbreviation
for :n:`let @ident := fun {+ @binder} => @term__1 in @term__2`.

.. seealso::

   Extensions of the `let ... in ...` syntax are described in
   :ref:`irrefutable-patterns`.

.. index::
   single: ... : ... (type cast)
   single: ... <: ... (VM type cast)
   single: ... <<: ... (native compute type cast)
   single: ... :> ... (volatile type cast)

.. _type-cast:

Type cast
---------

.. insertprodn term_cast term_cast

.. prodn::
   term_cast ::= @term99 <: @type
   | @term99 <<: @type
   | @term99 :> @type
   | @term99 : @type

The expression :n:`@term99 : @type` is a type cast expression. It enforces
the type of :n:`@term99` to be :n:`@type`.

:n:`@term99 <: @type` specifies that the virtual machine will be used
to type check that :n:`@term99` has type :n:`@type` (see :tacn:`vm_compute`).

:n:`@term99 <<: @type` specifies that compilation to OCaml will be used
to type check that :n:`@term99` has type :n:`@type` (see :tacn:`native_compute`).

:n:`@term99 :> @type` enforces the type of :n:`@term99` to be
:n:`@type` without leaving a trace in the produced value.
This is a :gdef:`volatile cast`.

If a scope is :ref:`bound <LocalInterpretationRulesForNotations>` to
:n:`@type` then :n:`@term99` is interpreted in that scope.

.. _gallina-definitions:

Top-level definitions
---------------------

Definitions extend the global environment by associating names to terms.
A definition can be seen as a way to give a meaning to a name or as a
way to abbreviate a term. In any case, the name can later be replaced at
any time by its definition.

The operation of unfolding a name into its definition is called
:term:`delta-reduction`.
A definition is accepted by the system if and only if the defined term is
well-typed in the current context of the definition and if the name is
not already used. The name defined by the definition is called a
:gdef:`constant` and the term it refers to is its :gdef:`body`. A definition has
a type, which is the type of its :term:`body`.

A formal presentation of constants and environments is given in
Section :ref:`typing-rules`.

.. cmd:: {| Definition | Example } @ident_decl @def_body
   :name: Definition; Example

   .. insertprodn def_body reduce

   .. prodn::
      def_body ::= {* @binder } {? : @type } := {? @reduce } @term
      | {* @binder } : @type
      reduce ::= Eval @red_expr in

   These commands bind :n:`@term` to the name :n:`@ident` in the global environment,
   provided that :n:`@term` is well-typed.  They can take the :attr:`local` :term:`attribute`,
   which makes the defined :n:`@ident` accessible only through their fully
   qualified names, even if :cmd:`Import` or its variants has been used on the
   current :cmd:`Module`.
   If :n:`@reduce` is present then :n:`@ident` is bound to the result of the specified
   computation on :n:`@term`.

   These commands also support the :attr:`universes(polymorphic)`, :attr:`refine`,
   :attr:`program` (see :ref:`program_definition`), :attr:`canonical`,
   :attr:`bypass_check(universes)`, :attr:`bypass_check(guard)`, :attr:`deprecated`,
   :attr:`warn` and :attr:`using` attributes.

   If :n:`@term` is omitted, :n:`@type` is required and Rocq enters proof mode.
   This can be used to define a term incrementally, in particular by relying on the :tacn:`refine` tactic.
   In this case, the proof should be terminated with :cmd:`Defined` in order to define a :term:`constant`
   for which the computational behavior is relevant.  See :ref:`proof-editing-mode`.

   The form :n:`Definition @ident : @type := @term` checks that the type of :n:`@term`
   is definitionally equal to :n:`@type`, and registers :n:`@ident` as being of type
   :n:`@type`, and bound to value :n:`@term`.

   The form :n:`Definition @ident {* @binder } : @type := @term` is equivalent to
   :n:`Definition @ident : forall {* @binder }, @type := fun {* @binder } => @term`.

   With attribute :attr:`refine`, the user can leave out parts of the definition (writing `_` instead)
   and Rocq enters proof mode to fill in the holes. :attr:`refine` is not compatible with :n:`@reduce`.

   .. seealso:: :cmd:`Opaque`, :cmd:`Transparent`, :tacn:`unfold`.

   .. exn:: @ident already exists.
      :name: ‘ident’ already exists. (Definition)
      :undocumented:

   .. exn:: The term @term has type @type while it is expected to have type @type'.
      :undocumented:

.. _Assertions:

Assertions and proofs
---------------------

An assertion states a proposition (or a type) for which the proof (or an
inhabitant of the type) is interactively built using :term:`tactics <tactic>`.
Assertions cause Rocq to enter :term:`proof mode` (see :ref:`proofhandling`).
Common tactics are described in the :ref:`tactics` chapter.
The basic assertion command is:

.. cmd:: @thm_token @ident_decl {* @binder } : @type {* with @ident_decl {* @binder } : @type }
   :name: Theorem; Lemma; Fact; Remark; Corollary; Proposition; Property

   .. insertprodn thm_token thm_token

   .. prodn::
      thm_token ::= Theorem
      | Lemma
      | Fact
      | Remark
      | Corollary
      | Proposition
      | Property

   After the statement is asserted, Rocq needs a proof. Once a proof of
   :n:`@type` under the assumptions represented by :n:`@binder`\s is given and
   validated, the proof is generalized into a proof of :n:`forall {* @binder }, @type` and
   the theorem is bound to the name :n:`@ident` in the global environment.

   These commands accept the :attr:`program` attribute.  See :ref:`program_lemma`.

   Forms using the :n:`with` clause are useful for theorems that are proved by simultaneous induction
   over a mutually inductive assumption, or that assert mutually dependent
   statements in some mutual coinductive type. It is equivalent to
   :cmd:`Fixpoint` or :cmd:`CoFixpoint` but using tactics to build the proof of
   the statements (or the :term:`body` of the specification, depending on the point of
   view). The inductive or coinductive types on which the induction or
   coinduction has to be done is assumed to be unambiguous and is guessed by
   the system.

   Like in a :cmd:`Fixpoint` or :cmd:`CoFixpoint` definition, the induction hypotheses
   have to be used on *structurally smaller* arguments (for a :cmd:`Fixpoint`) or
   be *guarded by a constructor* (for a :cmd:`CoFixpoint`). The verification that
   recursive proof arguments are correct is done only at the time of registering
   the lemma in the global environment. To know if the use of induction hypotheses is
   correct at some time of the interactive development of a proof, use the
   command :cmd:`Guarded`.

   This command accepts the :attr:`bypass_check(universes)`,
   :attr:`bypass_check(guard)`, :attr:`deprecated`, :attr:`warn`, and :attr:`using` attributes.

   .. exn:: The term @term has type @type which should be Set, Prop or Type.
      :undocumented:

   .. exn:: @ident already exists.
      :name: ‘ident’ already exists. (Theorem)

      The name you provided is already defined. You have then to choose
      another name.

   .. exn:: Nested proofs are discouraged and not allowed by default. This error probably means that you forgot to close the last "Proof." with "Qed." or "Defined.". \
            If you really intended to use nested proofs, you can do so by turning the "Nested Proofs Allowed" flag on.
      :name: Nested proofs are discouraged and not allowed by default

      You are asserting a new statement when you're already in proof mode.
      This feature, called nested proofs, is disabled by default.
      To activate it, turn the :flag:`Nested Proofs Allowed` flag on.

Proofs start with the keyword :cmd:`Proof`. Then Rocq enters the proof mode
until the proof is completed. In proof mode, the user primarily enters
tactics (see :ref:`tactics`). The user may also enter
commands to manage the proof mode (see :ref:`proofhandling`).

When the proof is complete, use the :cmd:`Qed` command so the kernel verifies
the proof and adds it to the global environment.

.. note::

   #. Several statements can be simultaneously asserted provided the
      :flag:`Nested Proofs Allowed` flag was turned on.

   #. Not only other assertions but any command can be given
      while in the process of proving a given assertion. In this case, the
      command is understood as if it would have been given before the
      statements still to be proved. Nonetheless, this practice is discouraged
      and may stop working in future versions.

   #. Proofs ended by :cmd:`Qed` are declared :term:`opaque`. Their content cannot be
      unfolded (see :ref:`applyingconversionrules`), thus
      realizing some form of *proof-irrelevance*.
      Proofs that end with :cmd:`Defined` can be unfolded.

   #. :cmd:`Proof` is recommended but can currently be omitted. On the opposite
      side, :cmd:`Qed` (or :cmd:`Defined`) is mandatory to validate a proof.

   #. One can also use :cmd:`Admitted` in place of :cmd:`Qed` to turn the
      current asserted statement into an axiom and exit proof mode.
