Heterogeneous value maps for OCaml
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
pkg
src
test
.gitignore
.merlin
.ocp-indent
CHANGES.md
LICENSE.md
README.md
_tags
opam

README.md

Hmap — Heterogeneous value maps for OCaml

%%VERSION%%

Hmap provides heterogeneous value maps for OCaml. These maps bind keys to values with arbitrary types. Keys witness the type of the value they are bound to which allows to add and lookup bindings in a type safe manner.

Hmap has no dependency and is distributed under the ISC license.

Home page: http://erratique.ch/software/hmap
Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>

Installation

Hmap can be installed with opam:

opam install hmap

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

Sample programs

If you installed Hmap with opam sample programs are located in the directory opam config var hmap:doc.

In the distribution sample programs and tests are located in the test directory of the distribution. They can be built an run with

topkg build --tests true
topkg test