Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beling/bsuccinct-rs
Rust libraries and programs focused on succinct data structures
https://github.com/beling/bsuccinct-rs
algorithm algorithms algorithms-and-data-structures benchmark benchmarking benchmarks bit-manipulation bitmap bitmaps compression compression-algorithm encoding minimal-perfect-hash rank rust rust-lang serialization succinct-data-structure
Last synced: about 13 hours ago
JSON representation
Rust libraries and programs focused on succinct data structures
- Host: GitHub
- URL: https://github.com/beling/bsuccinct-rs
- Owner: beling
- License: apache-2.0
- Created: 2022-02-25T12:32:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T08:07:44.000Z (9 months ago)
- Last Synced: 2024-04-24T07:24:00.634Z (8 months ago)
- Topics: algorithm, algorithms, algorithms-and-data-structures, benchmark, benchmarking, benchmarks, bit-manipulation, bitmap, bitmaps, compression, compression-algorithm, encoding, minimal-perfect-hash, rank, rust, rust-lang, serialization, succinct-data-structure
- Language: Rust
- Homepage:
- Size: 911 KB
- Stars: 98
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
Succinct data structures and other Rust libraries and programs by Piotr Beling.
[](https://github.com/beling/bsuccinct-rs/actions/)
[](https://github.com/beling/bsuccinct-rs)
[](LICENSE-APACHE)
[](LICENSE-MIT)
Included libraries:
- `ph` ([crate](https://crates.io/crates/ph), [doc](https://docs.rs/ph)) - minimal perfect hash functions (FMPH and FMPHGO);
- `csf` ([crate](https://crates.io/crates/csf), [doc](https://docs.rs/csf)) - compressed static functions (maps);
- `cseq` ([crate](https://crates.io/crates/cseq), [doc](https://docs.rs/cseq)) - compact sequences (like Elias-Fano);
- `minimum_redundancy` ([crate](https://crates.io/crates/minimum_redundancy), [doc](https://docs.rs/minimum_redundancy)) - encode and decode data with binary or non-binary Huffman coding;
- `bitm` ([crate](https://crates.io/crates/bitm), [doc](https://docs.rs/bitm)) - bit and bitmap manipulation;
- `seedable_hash` ([crate](https://crates.io/crates/seedable_hash), [doc](https://docs.rs/seedable_hash)) - seedable hashers,
- `binout` ([crate](https://crates.io/crates/binout), [doc](https://docs.rs/binout)) - binary encoding, decoding, serialization, deserialization;
- `fsum` ([crate](https://crates.io/crates/fsum), [doc](https://docs.rs/fsum)) - calculate accurate sum of floats;
- `dyn_size_of` ([crate](https://crates.io/crates/dyn_size_of), [doc](https://docs.rs/dyn_size_of)) - calculate memory consumed by variables, including the memory allocated on heap,
- `butils` ([crate](https://crates.io/crates/butils), [doc](https://docs.rs/butils)) - (internal) utilities shared by software included in BSuccinct.
Included programs:
- `mphf_benchmark` ([crate](https://crates.io/crates/mphf_benchmark), [doc](https://docs.rs/mphf_benchmark)) - benchmarking minimal perfect hash functions,
- `csf_benchmark` ([crate](https://crates.io/crates/csf_benchmark), [doc](https://docs.rs/csf_benchmark)) - benchmarking compressed static functions,
- `cseq_benchmark` ([crate](https://crates.io/crates/cseq_benchmark), [doc](https://docs.rs/cseq_benchmark)) - benchmarking compact sequences,
- `coding_benchmark` ([crate](https://crates.io/crates/coding_benchmark), [doc](https://docs.rs/coding_benchmark)) - benchmarking Huffman coding crates.
Everything is dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).
# Bibliography
When using `bsuccinct` for research purposes, please cite the following paper:
- Piotr Beling, *BSuccinct: Rust libraries and programs focused on succinct data structures*, SoftwareX, Volume 26, 2024, 101681, ISSN 2352-7110,
# Installation
Programs can be compiled and installed from sources. To do this, a Rust compiler is needed.
The easiest way to obtain the compiler along with other necessary tools (like `cargo`) is
to use [rustup](https://www.rust-lang.org/tools/install).
Please follow the instructions at https://www.rust-lang.org/tools/install.
## Installing rust programs
Once Rust is installed, to compile and install a program from sources and with native optimizations, just execute:
```RUSTFLAGS="-C target-cpu=native" cargo install ```
for example
```RUSTFLAGS="-C target-cpu=native" cargo install mphf_benchmark```
# Platforms with 32-bit addressing
For portability, BSuccinct components compile and run on platforms with 32-bit addressing (like wasm32). However, they are optimized primarily with 64-bit CPUs in mind.