Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytehamster/mphf-experiments
Comparison of different MPHF algorithms
https://github.com/bytehamster/mphf-experiments
Last synced: 2 months ago
JSON representation
Comparison of different MPHF algorithms
- Host: GitHub
- URL: https://github.com/bytehamster/mphf-experiments
- Owner: ByteHamster
- License: gpl-3.0
- Created: 2022-10-10T11:04:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T08:11:49.000Z (6 months ago)
- Last Synced: 2024-06-17T09:37:53.649Z (6 months ago)
- Language: C++
- Size: 2.58 MB
- Stars: 4
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MPHF-Experiments
Comparison of different minimal perfect hash functions (MPHFs).
### Cloning the Repository
This repository contains submodules.
To clone the repository including submodules, use the following command.
```
git clone --recursive https://github.com/ByteHamster/MPHF-Experiments.git
```
### Reproducing Experiments
This repository contains the source code and our reproducibility artifacts for our paper.
Due to the plethora of dependencies required by our competitors, we provide an easy to use Docker image to quickly reproduce our results.
Alternatively, you can look at the `Dockerfile` to see all libraries, tools, and commands necessary to compile the different competitors.
#### Building the Docker Image
Run the following command to build the Docker image.
Building the image takes about 10 minutes, as some packages (including LaTeX for the plots) have to be installed.
Note that your machine needs to support the AVX2 instruction set extension to successfully run the experiments.
```bash
docker build -t mmphf_experiments --no-cache .
```
Some compiler warnings (red) are expected when building competitors and will not prevent building the image or running the experiments.
Please ignore them!
#### Running the Experiments
Due to the long total running time of all experiments in our paper, we provide run scripts for a slightly simplified version of the experiments.
They run fewer iterations and output fewer data points.
You can modify the benchmarks scripts in `scripts/dockerVolume` if you want to change the number of runs or data points.
This does not require the Docker image to recompile.
Different experiments can be started by using the following command:
```bash
docker run --interactive --tty -v "$(pwd)/scripts/dockerVolume:/opt/dockerVolume" mmphf_experiments /opt/dockerVolume/.sh
```
`<script>` depends on the experiment you want to run.
| Figure | Launch command | Estimated runtime |
| :---------------------------------------------------------------------------------------------------------------------------- | :---------------------------------- | :----------------- |
| [SicHash](https://doi.org/10.1137/1.9781611977561.ch15), Figure 6 <br /><img src="preview-sichash-figure-6.png" width="300"/> | /opt/dockerVolume/comparison-N.sh | 20 minutes |
| [SicHash](https://doi.org/10.1137/1.9781611977561.ch15), Figure 8 <br /><img src="preview-sichash-figure-8.png" width="300"/> | /opt/dockerVolume/pareto.sh | 45 minutes |
| [GpuRecSplit](https://arxiv.org/pdf/2212.09562.pdf), Figure 6 <br /><img src="preview-gpurecsplit-figure-6.png" width="300"/> | /opt/dockerVolume/pareto-threads.sh | 45 minutes |
| ShockHash, Figure 5 <br /><img src="preview-shockhash-figure-5.png" width="300"/> | /opt/dockerVolume/pareto-zoomed.sh | 60 minutes |
The resulting plots can be found in `scripts/dockerVolume` and have the file extension `.pdf`.
### License
This code is licensed under the [GPLv3](/LICENSE).