Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
ByteHamster committed Apr 25, 2023
1 parent 9bdedc2 commit ec08efb
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ and [BuRR](https://github.com/lorenzhs/BuRR) for low-overhead retrieval.

A variant for variable-length strings provides significantly faster queries than competitors.

<img src="plots.png" alt="Screenshot of measurements in paper">
[<img src="plots.png" alt="Screenshot of measurements in paper">](https://arxiv.org/pdf/2304.11012)

### Requirements

Expand All @@ -19,14 +19,14 @@ A variant for variable-length strings provides significantly faster queries than

Clone the repository (as a submodule) and add the following to your `CMakeLists.txt`.

```
```cmake
add_subdirectory(path/to/LeMonHash)
target_link_libraries(YourTarget PRIVATE LeMonHash)
```

Then you can use the straight-forward interface of LeMonHash:

```
```cpp
std::vector<uint64_t> inputData {0, 1, 7, 15, 23, 42, 250};
lemonhash::LeMonHash<> hashFunc(inputData);
for (uint64_t x : inputData) {
Expand All @@ -37,4 +37,14 @@ for (uint64_t x : inputData) {
### License

This code is licensed under the [GPLv3](/LICENSE).
If you use the project in an academic context or publication, please cite our paper.
If you use the project in an academic context or publication, please cite our [paper](https://arxiv.org/pdf/2304.11012):

```bibtex
@article{ferragina2023learned,
title = {Learned Monotone Minimal Perfect Hashing},
author = {Paolo Ferragina and Hans-Peter Lehmann and Peter Sanders and Giorgio Vinciguerra},
journal = {arXiv preprint arXiv:2304.11012},
doi = {10.48550/ARXIV.2304.11012},
year = {2023},
}
```

0 comments on commit ec08efb

Please sign in to comment.