Equations - a function definition plugin.

Build Status DOI Gitter

Copyright 2009-2020 Matthieu Sozeau matthieu.sozeau@inria.fr
Copyright 2015-2018 Cyprien Mangin cyprien.mangin@m4x.org

Distributed under the terms of the GNU Lesser General Public License Version 2.1 or later (see LICENSE for details).

Equations provides a notation for writing programs by dependent pattern-matching and (well-founded) recursion in Coq. It compiles everything down to eliminators for inductive types, equality and accessibility, providing a definitional extension to the Coq kernel. The plugin can be used with Coq’s standard logic in Prop for a proof-irrelevant, erasable interpretation of pattern-matching, or with a polymorphic logic in Type or re-using the prelude of the HoTT/Coq library for a proof-relevant interpretation. In all cases, the resulting definitions are axiom-free.

Table of Contents

Live demo

Try it now in your browser with JSCoq!

Documentation

  • The reference manual provides an introduction and a summary of the commands and options. This introduction can also be followed interactively with Equations installed: equations_intro.v

  • A gallery of examples provides more consequent developments using Equations.

Papers and presentations

Installation

The latest version works with Coq 8.11 (branch 8.11), Coq 8.12 (branch 8.12), and the current Coq master branch (branch master).

See releases for sources and official releases.

Install with OPAM

This package is available on OPAM. Activate the Coq repository if you didn’t do it yet:

opam repo add coq-released https://coq.inria.fr/opam/released

and run:

opam install coq-equations

To get the beta versions of Coq, activate the repository:

opam repo add coq-core-dev https://coq.inria.fr/opam/core-dev

To get the development version of Equations, activate the repository:

opam repo add coq-extra-dev https://coq.inria.fr/opam/extra-dev

Install from source

Alternatively, to compile Equations, simply run:

./configure.sh
make

in the toplevel directory, with coqc and ocamlc in your path.

Optionally, one can build the test-suite or examples:

make examples test-suite

Then add the paths to your .coqrc:

Add ML Path "/Users/mat/research/coq/equations/src".
Add Rec LoadPath "/Users/mat/research/coq/equations/theories" as Equations.

Or install it:

make install

As usual, you will need to run this command with the appropriate privileges if the version of Coq you are using is installed system-wide, rather than in your own directory. E.g. on Ubuntu, you would prefix the command with sudo and then enter your user account password when prompted.

HoTT Variant

The HoTT variant of Equations works with the coq-hott library for Coq 8.10 and up. To install the plugin in an environment where hoqc is available, simply run:

./configure.sh HoTT

Then you can follow the standard instructions:

make all install

Note that only one of the HoTT variant or the standard variant can be installed at any given time. To use hoqtop or hoqc, one needs to pass the following options:

hoqtop/hoqc -I `coqc -where`/user-contrib/Equations -Q `coqc -where`/user-contrib ""

Then, one can import the plugin in Coq, using:

From Equations Require Import HoTT.All.