Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coq-community/paramcoq
Coq plugin for parametricity [maintainer=@proux01]
https://github.com/coq-community/paramcoq
coq coq-ci coq-platform coq-plugin docker-coq-action parametricity
Last synced: 3 days ago
JSON representation
Coq plugin for parametricity [maintainer=@proux01]
- Host: GitHub
- URL: https://github.com/coq-community/paramcoq
- Owner: coq-community
- License: other
- Created: 2014-11-21T11:49:40.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T11:26:59.000Z (3 months ago)
- Last Synced: 2024-12-17T15:02:36.391Z (11 days ago)
- Topics: coq, coq-ci, coq-platform, coq-plugin, docker-coq-action, parametricity
- Language: Coq
- Homepage:
- Size: 481 KB
- Stars: 45
- Watchers: 12
- Forks: 24
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# Paramcoq
[![Docker CI][docker-action-shield]][docker-action-link]
[![Contributing][contributing-shield]][contributing-link]
[![Code of Conduct][conduct-shield]][conduct-link]
[![Zulip][zulip-shield]][zulip-link]
[![DOI][doi-shield]][doi-link]
[docker-action-shield]: https://github.com/coq-community/paramcoq/workflows/Docker%20CI/badge.svg?branch=master
[docker-action-link]: https://github.com/coq-community/paramcoq/actions?query=workflow:"Docker%20CI"
[contributing-shield]: https://img.shields.io/badge/contributions-welcome-%23f7931e.svg
[contributing-link]: https://github.com/coq-community/manifesto/blob/master/CONTRIBUTING.md
[conduct-shield]: https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-%23f15a24.svg
[conduct-link]: https://github.com/coq-community/manifesto/blob/master/CODE_OF_CONDUCT.md
[zulip-shield]: https://img.shields.io/badge/chat-on%20zulip-%23c1272d.svg
[zulip-link]: https://coq.zulipchat.com/#narrow/stream/237663-coq-community-devs.20.26.20users
[doi-shield]: https://zenodo.org/badge/DOI/10.4230/LIPIcs.CSL.2012.381.svg
[doi-link]: https://doi.org/10.4230/LIPIcs.CSL.2012.381
A Coq plugin providing commands for generating parametricity statements.
Typical applications of such statements are in data refinement proofs.
Note that the plugin is still in an experimental state - it is not very user
friendly (lack of good error messages) and still contains bugs. But it
is usable enough to "translate" a large chunk of the standard library.
## Meta
- Author(s):
- Chantal Keller (initial)
- Marc Lasson (initial)
- Abhishek Anand
- Pierre Roux
- Emilio Jesús Gallego Arias
- Cyril Cohen
- Matthieu Sozeau
- Coq-community maintainer(s):
- Pierre Roux ([**@proux01**](https://github.com/proux01))
- License: [MIT License](LICENSE)
- Compatible Coq versions: The master branch tracks the development version of Coq, see releases for compatibility with released versions of Coq
- Additional dependencies: none
- Coq namespace: `Param`
- Related publication(s):
- [Parametricity in an Impredicative Sort](https://hal.archives-ouvertes.fr/hal-00730913/) doi:[10.4230/LIPIcs.CSL.2012.381](https://doi.org/10.4230/LIPIcs.CSL.2012.381)
## Building and installation instructions
The easiest way to install the latest released version of Paramcoq
is via [OPAM](https://opam.ocaml.org/doc/Install.html):
```shell
opam repo add coq-released https://coq.inria.fr/opam/released
opam install coq-paramcoq
```
To instead build and install manually, do:
``` shell
git clone https://github.com/coq-community/paramcoq.git
cd paramcoq
make # or make -j
make install
```
## Usage and Commands
To load the plugin and make its commands available:
```coq
From Param Require Import Param.
```
The command scheme for named translations is:
```
Parametricity as [arity ].
```
For example, the following command generates a translation named `my_param`
of the constant or inductive `my_id` with arity 2 (the default):
```coq
Parametricity my_id as my_param.
```
The command scheme for automatically named translations is:
```coq
Parametricity [Recursive] [arity ] [qualified].
```
Such commands generate and name translations based on the given identifier.
The `Recursive` option can be used to recursively translate all the constants
and inductives which are used by the constant or inductive with the given
identifier. The `qualified` option allows you to use a qualified default name
for the translated constants and inductives. The default name then has the form
`Module_o_Submodule_o_my_id` if the identifier `my_id` is declared in the
`Module.Submodule` namespace.
Instead of using identifiers, you can provide explicit terms to translate,
according to the following command scheme:
```coq
Parametricity Translation [as ] [arity ].
```
This defines a new constant containing the parametricity translation of
the given term.
To recursively translate everything in a module:
```coq
Parametricity Module .
```
When translating terms containing section variables or axioms,
it may be useful to declare a term to be the translation of a constant:
```coq
Realizer [as ] [arity ] := .
```
Note that translating a term or module may lead to proof obligations (for some
fixpoints and opaque terms if you did not import `ProofIrrelevence`). You need to
declare a tactic to solve such proof obligations:
```coq
Parametricity Tactic := .
```
(supports global/export/local attributes like Obligation Tactic)