kmers_rs/
lib.rs

1#![warn(missing_docs)]
2
3//! K-mers and associated operations.
4//! 
5//! This library provides functionality for extracting k-mers from sequences,
6//! and manipulating them in useful ways. The underlying representation is
7//! 64-bit integers (`u64`), so k > 32 is not supported by this library.
8//! 
9//! K-mers (or q-grams in some computer science contexts) are k-length sequences
10//! of DNA/RNA "letters" represented as unsigned integers. Following usual practice,
11//! 
12//! * "A" -> b00
13//! * "C" -> b01
14//! * "G" -> b10
15//! * "T" or "U" -> b11
16//! 
17//! which has the nice property that the complementary bases are bitwise complements.
18//!  
19
20mod basics;
21mod accumulator;
22mod frequency;
23mod list;
24mod dot;
25mod jaccard;
26mod vbyte;
27
28pub use basics::*;
29pub use accumulator::*;
30pub use frequency::*;
31pub use list::*;
32pub use dot::*;
33pub use jaccard::*;