https://github.com/bytehamster/simpleribbon

BuRR (bumped ribbon retrieval), but with CMake support and a non-header library to reduce compile times.
https://github.com/bytehamster/simpleribbon

Last synced: 22 days ago
JSON representation

BuRR (bumped ribbon retrieval), but with CMake support and a non-header library to reduce compile times.

• Host: GitHub
• URL: https://github.com/bytehamster/simpleribbon
• Owner: ByteHamster
• License: apache-2.0
• Created: 2022-10-18T09:45:09.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-15T15:15:41.000Z (about 1 month ago)
• Last Synced: 2024-11-15T16:26:00.444Z (about 1 month ago)
• Language: C++
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SimpleRibbon

[BuRR](https://github.com/lorenzhs/BuRR) (bumped ribbon retrieval), but with CMake support and a **non**-header-only library to reduce compile times.

Due to this being a static library, only a small selection of configurations is available.

You can find these in the [source file](/SimpleRibbon.cpp).

### Library usage

Clone this repository (with submodules) and add the following to your `CMakeLists.txt`.

```

add_subdirectory(path/to/SimpleRibbon)

target_link_libraries(YourTarget PRIVATE SimpleRibbon)

```

You can then use it as follows:

```

#include 

std::vector> inputData = ...;

SimpleRibbon<1> ribbon(inputData); // 1-bit BuRR

std::cout << ribbon1->retrieve(hashedKey) << std::endl;

```

### Citation

If you use SimpleRibbon in the context of an academic publication, we ask that you please cite the BuRR paper:

```bibtex

@inproceedings{BuRR2022,

    author={Peter C. Dillinger, Lorenz Hübschle-Schneider, Peter Sanders, and Stefan Walzer},

    title={Fast Succinct Retrieval and Approximate Membership using Ribbon},

    booktitle={20th International Symposium on Experimental Algorithms (SEA 2022)},

    pages={4:1--4:20},

    year={2022},

    doi={10.4230/LIPIcs.SEA.2022.4}

}

```

### License

This code is licensed under the [Apache 2.0 license](/LICENSE).