bfield 0.3.0

B-field datastructure implementation in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

#![deny(missing_docs)]

//! The B-field datastructure, implemented in Rust.
//! A space-efficient, probabilistic data structure and storage and retrieval method for key-value information.
//! These Rust docs represent some minimal documentation of the crate itself.
//! See the [Github README](https://github.com/onecodex/rust-bfield) for an
//! extensive write-up, including the math and design underpinning the B-field
//! data structure, guidance on B-field parameter selection, as well as usage
//! examples.[^1]
//!
//! [^1]: These are not embeddable in the Cargo docs as they include MathJax,
//! which is currently unsupported.

mod bfield;
mod bfield_member;
/// Some combinatorial utilities
mod combinatorial;

pub use crate::bfield::BField;
pub use crate::bfield_member::BFieldVal;
pub use combinatorial::choose;