Skip to content

Commit

Permalink
Small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
dlesbre committed Apr 16, 2024
1 parent dedd568 commit b379b27
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This library can be installed with:
```bash
opam install patricia-tree
```
Alternatively, you can clone this repository and install with dune:
Alternatively, you can clone the source repository and install with dune:
```bash
git clone [email protected]:codex-semantics-library/patricia-tree.git
cd patricia-tree
Expand All @@ -43,8 +43,8 @@ dune install
- Similar to OCaml's `Map` and `Set`, using the same function names when possible
and the same convention for order of arguments. This should allow switching to
and from Patricia Tree with minimal effort.
- `Key` module requires an injective `to_int : t -> int` function instead of a
`compare` function.
- The functor parameters (`Key` module) requires an injective `to_int : t -> int`
function instead of a `compare` function.
- The Patricia Tree representation is stable, contrary to maps, inserting nodes
in any order will return the same shape.
This allows different versions of a map to share more subtrees in memory, and
Expand Down Expand Up @@ -121,6 +121,9 @@ Here is a brief overview of the various module types of our library:
(node which contain a unique identifier), `SetNode` (node optimized for set,
doesn't store the `unit` value) and `WeakSetNode`.

Use the functors `MakeCustomHeterogeneous` and `MakeCustomHeterogenous` to build maps using
these nodes, or any other custom nodes.

## Examples

### Non-generic map (homogeneous)
Expand Down

0 comments on commit b379b27

Please sign in to comment.