Expand description
High-Level Rust wrapper for the blitzar-sys
crate.
For the Rust sys-crate and the C++ repo, check
here.
§Considerations:
- The current library only supports
x86_64
architectures and only the Linux operating system. - The library was tested in the
ubuntu22.04
Linux environment. - Consider using
docker
or a virtual machine. - You must have the latest Rust environment installed in your Linux machine. Download here.
§Use
Add the following two lines to your Cargo.toml
file:
[dependencies]
blitzar = <version_number>
Import the necessary modules to your rust code:
use blitzar::sequence::*;
use blitzar::compute::*;
§Examples
All the examples are located in the examples/
directory. Each one has its own .rs
file. To run some example, use the following command:
cargo run --features <cpu|gpu> --example <example_name>
§Tests
cargo test
§Benchmarks
Benchmarks are run using criterion.rs:
cargo bench --features gpu