Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coq-community/huffman
Correctness proof of the Huffman coding algorithm in Coq [maintainer=@palmskog]
https://github.com/coq-community/huffman
coq coq-extraction coq-nix-toolbox docker-coq-action huffman-coding huffman-tree ocaml
Last synced: 29 days ago
JSON representation
Correctness proof of the Huffman coding algorithm in Coq [maintainer=@palmskog]
- Host: GitHub
- URL: https://github.com/coq-community/huffman
- Owner: coq-community
- License: other
- Created: 2016-04-27T13:31:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-30T00:35:06.000Z (12 months ago)
- Last Synced: 2024-04-22T06:26:30.328Z (8 months ago)
- Topics: coq, coq-extraction, coq-nix-toolbox, docker-coq-action, huffman-coding, huffman-tree, ocaml
- Language: Coq
- Homepage: https://coq-community.org/huffman/
- Size: 1.11 MB
- Stars: 14
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Huffman
[![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]
[![coqdoc][coqdoc-shield]][coqdoc-link]
[docker-action-shield]: https://github.com/coq-community/huffman/actions/workflows/docker-action.yml/badge.svg?branch=master
[docker-action-link]: https://github.com/coq-community/huffman/actions/workflows/docker-action.yml
[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
[coqdoc-shield]: https://img.shields.io/badge/docs-coqdoc-blue.svg
[coqdoc-link]: https://coq-community.org/huffman/docs/latest/coqdoc/toc.html
This projects contains a Coq proof of the correctness of the Huffman coding algorithm,
as described in David A. Huffman's paper A Method for the Construction of Minimum-Redundancy
Codes, Proc. IRE, pp. 1098-1101, September 1952.
## Meta
- Author(s):
- Laurent Théry (initial)
- Karl Palmskog [
](https://orcid.org/0000-0003-0228-1240)
- Coq-community maintainer(s):
- Karl Palmskog ([**@palmskog**](https://github.com/palmskog))
- License: [GNU Lesser General Public License v2.1 or later](LICENSE)
- Compatible Coq versions: 8.12 or later
- Additional dependencies: none
- Coq namespace: `Huffman`
- Related publication(s):
- [Formalising Huffman's algorithm](https://hal.archives-ouvertes.fr/hal-02149909)
- [A Method for the Construction of Minimum-Redundancy Codes](http://compression.ru/download/articles/huff/huffman_1952_minimum-redundancy-codes.pdf) doi:[10.1109/JRPROC.1952.273898](https://doi.org/10.1109/JRPROC.1952.273898)
## Building and installation instructions
The easiest way to install the latest released version of Huffman
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-huffman
```
To instead build and install manually, do:
``` shell
git clone https://github.com/coq-community/huffman.git
cd huffman
make # or make -j
make install
```
## Documentation
For more information about the project, see the [technical report][techreport]
describing the formalization. See also the [coqdoc presentation][coqdoc] of the
Coq source files from the latest release.
### Running extracted code
To extract code and obtain the program, run
```shell
make run_huffman.ml
```
Next, open an OCaml toplevel (e.g., `ocaml`) and do
```ocaml
#use "run_huffman.ml";;
```
To get the code that gives the frequency string:
```ocaml
let code = huffman "abbcccddddeeeee";;
```
To code a string:
```ocaml
let c = encode code "abcde";;
```
To decode a string:
```ocaml
decode code c;;
```
[techreport]: https://hal.archives-ouvertes.fr/hal-02149909
[coqdoc]: https://coq-community.org/huffman/docs/latest/coqdoc/toc.html