simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 03:05:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

update of readme

Browse source
This commit is contained in:
Simon Cruanes 2014-10-01 15:15:24 +02:00
parent 3e08abf6a9
commit 293ff2958b
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -15,7 +15,9 @@ ocaml-containers
3. A drop-in replacement to the standard library, `containers.pervasives`, 3. A drop-in replacement to the standard library, `containers.pervasives`,
that defined a `CCPervasives` module intented to be opened to extend some that defined a `CCPervasives` module intented to be opened to extend some
modules of the stdlib. modules of the stdlib.
4. Random stuff, with *NO* *GUARANTEE* of even being barely usable or tested, 4. A sub-library with complicated abstractions, `containers.advanced` (with
a LINQ-like query module, batch operations using GADTs, and others)
5. 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 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 tend to write code when I want to test some idea, so half the modules (at
least) are unfinished or don't really work. least) are unfinished or don't really work.
@ -60,7 +62,6 @@ structures comprise (some modules in `misc/`, some other in `core/`):
- `CCKList`, a persistent iterator structure (akin to a lazy list) - `CCKList`, a persistent iterator structure (akin to a lazy list)
- `CCList`, functions on lists, including tail-recursive implementations of `map` and `append` and many other things - `CCList`, functions on lists, including tail-recursive implementations of `map` and `append` and many other things
- `CCArray`, utilities on arrays and slices - `CCArray`, utilities on arrays and slices
- `CCLinq`, high-level query language over collections
- `CCMultimap` and `CCMultiset`, functors defining persistent structures - `CCMultimap` and `CCMultiset`, functors defining persistent structures
- `CCHashtbl`, an extension of the standard hashtbl module - `CCHashtbl`, an extension of the standard hashtbl module
- `CCFlatHashtbl`, a flat (open-addressing) hashtable functorial implementation - `CCFlatHashtbl`, a flat (open-addressing) hashtable functorial implementation
@ -80,12 +81,25 @@ structures comprise (some modules in `misc/`, some other in `core/`):
### String ### String
See [doc](http://cedeela.fr/~simon/software/containers/string).
In the module `Containers_string`: In the module `Containers_string`:
- `Levenshtein`: edition distance between two strings - `Levenshtein`: edition distance between two strings
- `KMP`: Knuth-Morris-Pratt substring algorithm - `KMP`: Knuth-Morris-Pratt substring algorithm
### Advanced
See [doc](http://cedeela.fr/~simon/software/containers/advanced).
In the module `Containers_advanced`:
- `CCLinq`, high-level query language over collections
- `CCCat`, a few categorical structures
- `CCBatch`, to combine operations on collections into one traversal
### Misc ### Misc
See [doc](http://cedeela.fr/~simon/software/containers/misc).
- `PHashtbl`, a polymorphic hashtable (with open addressing) - `PHashtbl`, a polymorphic hashtable (with open addressing)
- `SplayTree`, a polymorphic splay heap implementation (not quite finished) - `SplayTree`, a polymorphic splay heap implementation (not quite finished)
- `SplayMap`, a polymorphic functional map based on splay trees - `SplayMap`, a polymorphic functional map based on splay trees