Skip to content

Commit ae00894

Browse files
author
julian
committed
Update README with instructions to enable robin_hood support
Signed-off-by: julian <julian.burellaperez@heig-vd.ch>
1 parent f784e1f commit ae00894

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,18 @@ pip install ripser
5555

5656
If you are having trouble installing, please let us know!
5757

58+
## Optional dependency
59+
60+
Ripser.py when compiled from source can have a *steroid*<sup>1</sup> shot by replacing the standard `unordered_map` from the STL by one of the fastest implementation available: [robin_hood](https://github.com/martinus/robin-hood-hashing). Benchmarking of Ripser.py using the `robin_hood` implementation showed speed-ups up to **30%**.
61+
62+
To be able to use `robin_hood` instead of STL, you only need to clone the repository containing the implementation:
63+
64+
```
65+
# Run this command at the root of the project
66+
git clone https://github.com/martinus/robin-hood-hashing ripser/robinhood
67+
```
68+
69+
<sup>1</sup> The Python package is already compiled with `robin_hood` by default.
5870

5971
## Usage
6072

0 commit comments

Comments
 (0)