update of README and .mllib

This commit is contained in:
Simon Cruanes 2013-03-14 14:45:33 +01:00
parent 707d29210f
commit 9d556cb106
2 changed files with 12 additions and 9 deletions

View file

@ -1,8 +1,9 @@
ocaml-containers ocaml-containers
================ ================
A bunch of containers,written in different occasions. Probably not very high A bunch of containers,written in different occasions. Not all
quality, since not all containers are tested (yet). containers are properly tested (see `tests/` and `make tests`
if you have installed `OUnit`).
The design is centerred around polymorphism rather than functors. Such The design is centerred around polymorphism rather than functors. Such
structures comprise: structures comprise:
@ -12,13 +13,16 @@ structures comprise:
- `Heap`, an imperative heap based on `SplayTree` - `Heap`, an imperative heap based on `SplayTree`
- `Graph`, a polymorphic imperative directed graph (on top of `PHashtbl`) - `Graph`, a polymorphic imperative directed graph (on top of `PHashtbl`)
- `Hashset`, a polymorphic imperative set on top of `PHashtbl` - `Hashset`, a polymorphic imperative set on top of `PHashtbl`
- `FQueue`, a purely functional queue structure
- `Heap`, a purely functional polymorphic heap
Other structures (not touched for months, may not work properly) are: Other structures are:
- `Cache`, a low level memoization cache for pairs of keys - `Univ`, a universal type encoding with affectation
- `Vector`, a growable array (pure OCaml, no C) - `Cache`, a low level memoization cache for unary and binary functions
- `Deque`, an imperative double ended FIFO (double-linked list) - `Deque`, an imperative double ended FIFO (double-linked list)
- `FlatHashtbl`, a deprecated open addressing hashtable with - `Vector`, a growable array (pure OCaml, no C; not tested)
- `FlatHashtbl`, a (deprecated) open addressing hashtable with
a functorial interface (replaced by PHashtbl) a functorial interface (replaced by PHashtbl)
## Use ## Use
@ -32,9 +36,7 @@ If you have comments, requests, or bugfixes, please share them! :-)
## Build ## Build
You need the library `sequence`. With opam, type `opam install sequence`. There are no dependencies (`Sequence` is included). Type:
Then:
$ make $ make

View file

@ -6,6 +6,7 @@ FlatHashtbl
FHashtbl FHashtbl
FQueue FQueue
Hashset Hashset
Sequence
SplayTree SplayTree
PHashtbl PHashtbl
Heap Heap