Commit 1b9c211f authored by POTTIER Francois's avatar POTTIER Francois
Browse files

Tweaks in README.

parent c6fd0fa6
...@@ -15,12 +15,12 @@ This gives you access to the following submodules: ...@@ -15,12 +15,12 @@ This gives you access to the following submodules:
* [`CompactQueue`](src/CompactQueue.mli) offers **a minimalist mutable * [`CompactQueue`](src/CompactQueue.mli) offers **a minimalist mutable
FIFO queue** that is tuned for performance. FIFO queue** that is tuned for performance.
* [`DataFlow`](src/DataFlow.mli) performs a forward data flow analysis * [`DataFlow`](src/DataFlow.mli) performs a **forward data flow analysis**
over a directed graph. Like [`Fix`](src/Core.mli), it computes the over a directed graph. Like [`Fix`](src/Core.mli), it computes the
least function of type `variable -> property` that satisfies a fixed least function of type `variable -> property` that satisfies a fixed
point equation. It is less widely applicable than `Fix`, but, when point equation. It is less widely applicable than `Fix`, but, when
it is applicable, it is easier to use and more efficient than `Fix`. it is applicable, it is easier to use and more efficient than `Fix`.
`DataFlow.ForCustomMaps` is particularly tuned for performance. `DataFlow.ForCustomMaps` is particularly **tuned for performance**.
* [`Gensym`](src/Gensym.mli) offers a simple facility * [`Gensym`](src/Gensym.mli) offers a simple facility
for **generating fresh integer identifiers**. for **generating fresh integer identifiers**.
...@@ -60,6 +60,8 @@ This gives you access to the following submodules: ...@@ -60,6 +60,8 @@ This gives you access to the following submodules:
The function thus obtained performs the fixed point The function thus obtained performs the fixed point
computation on demand, in an incremental manner, computation on demand, in an incremental manner,
and is memoizing. and is memoizing.
This is typically used to perform a **backward data flow analysis**
over a directed graph.
* `Prop` defines a few common partial orders, including * `Prop` defines a few common partial orders, including
[`Prop.Boolean`](src/Boolean.mli), [`Prop.Boolean`](src/Boolean.mli),
...@@ -73,9 +75,6 @@ The signatures that appear in the above files, ...@@ -73,9 +75,6 @@ The signatures that appear in the above files,
such as `MEMOIZER`, `TABULATOR`, `SOLVER`, and so on, such as `MEMOIZER`, `TABULATOR`, `SOLVER`, and so on,
are defined [here](src/Sigs.ml). are defined [here](src/Sigs.ml).
The documentation is built by `make doc` and is then found in the
file `_build/default/_doc/_html/index.html`.
The [documentation of the latest released The [documentation of the latest released
version](http://cambium.inria.fr/~fpottier/fix/doc/fix/Fix/index.html) version](http://cambium.inria.fr/~fpottier/fix/doc/fix/Fix/index.html)
is also available online. is also available online.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment