From f0f2a72830efbfa49d12dc8f1591779f20c07152 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franc=CC=A7ois=20Pottier?= <francois.pottier@inria.fr> Date: Fri, 24 Dec 2021 15:30:26 +0100 Subject: [PATCH] README. --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f6a3399..7512c65 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,17 @@ It can perhaps be compared with the Haskell library [testing-feat](https://hackage.haskell.org/package/testing-feat), although a detailed comparison has not been carried out. -The library is laid out as follows: +Two packages, `feat` and `feat-num`, offer the same API. +`feat` relies on the big integer library `zarith`, +whereas `feat-num` relies on the library `num`. +Both packages offer the same API: the main module +(named `Feat` or `FeatNum`) offers three submodules +named `Num`, `IFSeq`, and `Enum`. -* The module [Feat.IFSeq](src/IFSeq.mli) implements - the signature [Feat.IFSEQ](src/IFSeqSig.ml) +* The submodule `Num` implements a small set of operations on big integers. + +* The submodule `IFSeq` implements + the signature [IFSEQ_EXTENDED](feat-core/IFSeqSig.ml) of (implicit, finite) **sequences**. These sequences are implicit, which means that they are not explicitly @@ -24,15 +31,12 @@ The library is laid out as follows: some constraints on the operations that can be efficiently supported; for instance, `filter` is not supported. -* The module [Feat.Enum](src/Enum.mli) implements +* The submodule `Enum` implements + the signature [ENUM](feat-core/EnumSig.ml) of **enumerations**. An enumeration of type `'a enum` is a function of a size `s` to a sequence of elements of size `s`. -* The module [Feat.Bigint](src/bigint.mli) - offers a function `random` of type `Z.t -> Z.t`, - thus repairing an unfortunate omission in the library `zarith`. - * The external library [Fix](https://gitlab.inria.fr/fpottier/fix/) comes in handy when building enumerations -- GitLab