mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
update of readme
This commit is contained in:
Simon Cruanes
parent
488e97b439
commit
1fd7b9fbe0
1 changed files with 72 additions and 36 deletions
108
README.md
108
README.md
|
|
@ -1,14 +1,66 @@
|
|||
ocaml-containers
|
||||
================
|
||||
|
||||
A bunch of containers,written in different occasions. Not all
|
||||
containers are properly tested (see `tests/` and `make tests`
|
||||
if you have installed `OUnit`).
|
||||
A bunch of modules I wrote mostly for fun. It is currently divided into
|
||||
a few parts:
|
||||
|
||||
The documentation can be found [here](http://cedeela.fr/~simon/software/containers).
|
||||
1. A usable, reasonably well-designed library that extends OCaml's standard
|
||||
library (in `core/`, packaged under `containers` in ocamlfind. Modules
|
||||
are totally independent and are prefixed with `CC` (for "containers-core"
|
||||
or "companion-cube" because I'm megalomaniac). This part should be
|
||||
usable and should work. For instance, `CCList` contains functions and
|
||||
lists including safe versions of `map` and `append`.
|
||||
2. A satellite library, `containers.string` (in directory `string`) with
|
||||
a few packed modules that deal with strings (Levenshtein distance,
|
||||
KMP search algorithm, and a few naive utils). Again, modules are independent
|
||||
and sometimes parametric on the string and char types (so they should
|
||||
be able to deal with your favorite unicode library).
|
||||
3. Random stuff, with *NO* *GUARANTEE* of even being barely usable or tested,
|
||||
in other dirs (mostly `misc` but also `lwt` and `threads`). It's where I
|
||||
tend to write code when I want to test some idea, so half the modules (at
|
||||
least) are unfinished or don't really work.
|
||||
|
||||
Some of the modules have been moved to their own repository (e.g. `sequence`,
|
||||
`gen`, `qcheck` and are on opam for great fun and profit (or not)).
|
||||
|
||||
## Use
|
||||
|
||||
You can either build and install the library (see `Build`), or just copy
|
||||
files to your own project. The last solution has the benefits that you
|
||||
don't have additional dependencies nor build complications (and it may enable
|
||||
more inlining). Since modules have a friendly license and are mostly
|
||||
independent, both options are easy.
|
||||
|
||||
If you have comments, requests, or bugfixes, please share them! :-)
|
||||
|
||||
## License
|
||||
|
||||
This code is free, under the BSD license.
|
||||
|
||||
## Documentation
|
||||
|
||||
The API documentation can be
|
||||
found [here](http://cedeela.fr/~simon/software/containers).
|
||||
|
||||
## Contents
|
||||
|
||||
The design is mostly centered around polymorphism rather than functors. Such
|
||||
structures comprise:
|
||||
structures comprise (some modules in `misc/`, some other in `core/`):
|
||||
|
||||
### Core Structures
|
||||
|
||||
- `CCLeftistheap`, a polymorphic heap structure.
|
||||
- `CCFQueue`, a purely functional queue structure
|
||||
- `CCBV`, mutable bitvectors
|
||||
- `CCPersistentHashtbl`, a semi-persistent hashtable (similar
|
||||
to [persistent arrays](https://www.lri.fr/~filliatr/ftp/ocaml/ds/parray.ml.html))
|
||||
- `CCVector`, a growable array (pure OCaml, no C)
|
||||
|
||||
- `CCGen` and `CCSequence`, generic iterators structures (with structural types
|
||||
so they can be defined in several places). Now also in their own
|
||||
repository and opam packages (`gen` and `sequence`).
|
||||
|
||||
### Misc
|
||||
|
||||
- `PHashtbl`, a polymorphic hashtable (with open addressing)
|
||||
- `SplayTree`, a polymorphic splay heap implementation (not quite finished)
|
||||
|
|
@ -18,31 +70,24 @@ structures comprise:
|
|||
- `Hashset`, a polymorphic imperative set on top of `PHashtbl`
|
||||
- `LazyGraph`, a lazy graph structure on arbitrary (hashable+eq) types, with
|
||||
basic graph functions that work even on infinite graphs, and printing to DOT.
|
||||
- `FQueue`, a purely functional queue structure
|
||||
- `Heap`, a purely functional polymorphic heap
|
||||
- `Bij`, a GADT-based bijection language used to serialize/deserialize your
|
||||
data structures
|
||||
- `RAL`, a random-access list structure, with `O(1)` cons/hd/tl and `O(ln(n))`
|
||||
access to elements by their index.
|
||||
- `Leftistheap`, a polymorphic heap structure.
|
||||
- `SmallSet`, a sorted list implementation behaving like a set.
|
||||
- `AbsSet`, an abstract Set data structure, a bit like `LazyGraph`.
|
||||
|
||||
Other structures are:
|
||||
|
||||
- `Univ`, a universal type encoding with affectation
|
||||
- `Cache`, a low level memoization cache for unary and binary functions
|
||||
- `PersistentHashtbl`, a semi-persistent hashtable (similar to
|
||||
[persistent arrays](https://www.lri.fr/~filliatr/ftp/ocaml/ds/parray.ml.html))
|
||||
- `Deque`, an imperative double ended FIFO (double-linked list)
|
||||
- `Future`, a set of tools for preemptive threading, including a thread pool,
|
||||
monadic futures, and MVars (concurrent boxes)
|
||||
- `Vector`, a growable array (pure OCaml, no C; not tested)
|
||||
- `FlatHashtbl`, a (deprecated) open addressing hashtable with
|
||||
a functorial interface (replaced by PHashtbl)
|
||||
- `Gen` and `Sequence`, generic iterators structures.
|
||||
- `UnionFind`, a functorial imperative Union-Find structure.
|
||||
- `HGraph`, a structure of generalized hypergraphs
|
||||
|
||||
### Others
|
||||
|
||||
- `Future`, a set of tools for preemptive threading, including a thread pool,
|
||||
monadic futures, and MVars (concurrent boxes)
|
||||
|
||||
Some serialisation formats are also implemented, with a streaming, non-blocking
|
||||
interface that allows the user to feed the input in chunk by chunk (useful
|
||||
|
|
@ -51,37 +96,28 @@ in combination with Lwt/Async). Currently, the modules are:
|
|||
- `Bencode`, for the [B-encode format](http://en.wikipedia.org/wiki/Bencode),
|
||||
- `Sexp`, for S-expressions.
|
||||
|
||||
There is a QuickCheck-like library called `QCheck`.
|
||||
|
||||
## Use
|
||||
|
||||
You can either build and install the library (see `Build`), or just copy
|
||||
files to your own project. The last solution has the benefits that you
|
||||
don't have additional dependencies nor build complications (and it may enable
|
||||
more inlining). I therefore recommand it for its simplicity.
|
||||
|
||||
If you have comments, requests, or bugfixes, please share them! :-)
|
||||
There is a QuickCheck-like library called `QCheck` (now in its own repo).
|
||||
|
||||
## Build
|
||||
|
||||
There are no dependencies (`Sequence` is included).
|
||||
The `Bij` module requires OCaml `>= 4.00`. Type:
|
||||
|
||||
The `Bij` module requires OCaml `>= 4.00` because of GADTs. Type:
|
||||
|
||||
$ make
|
||||
|
||||
To build and run tests (requires `oUnit`):
|
||||
To build and run tests (requires `oUnit` and `qtest`):
|
||||
|
||||
$ opam install oUnit
|
||||
$ make tests
|
||||
$ ./tests.native
|
||||
|
||||
To build the small benchmarking suite (requires `Bench`):
|
||||
and
|
||||
|
||||
$ opam install bench
|
||||
$ opam install qtest
|
||||
$ make qtest
|
||||
|
||||
To build the small benchmarking suite (requires `benchmark`):
|
||||
|
||||
$ opam install benchmark
|
||||
$ make bench
|
||||
$ ./benchs.native
|
||||
|
||||
## License
|
||||
|
||||
This code is free, under the BSD license.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue