rsomics-kmer 0.2.0

K-mer encoding, canonicalisation, ntHash rolling hash, MurmurHash3, k-mer counting for the rsomics-* tool family. Layer A primitive.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

#![allow(
    clippy::cast_possible_truncation,
    clippy::missing_errors_doc,
    clippy::missing_panics_doc,
    clippy::must_use_candidate
)]

pub mod count;
pub mod encode;
pub mod hash;
pub mod iter;
pub mod roll;

pub use count::KmerCounts;
pub use encode::{Kmer, base_bits, canonical, decode, encode, reverse_complement};
pub use hash::{murmur3_x64_128, nthash_iter, nthash_one};
pub use iter::KmerIter;
pub use roll::RollingKmers;

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum KmerError {
    #[error("k must be in 1..=32 (got {0})")]
    KOutOfRange(usize),
    #[error("sequence shorter than k: len={len}, k={k}")]
    SeqTooShort { len: usize, k: usize },
    #[error("non-ACGT base at position {pos}: {byte:?}")]
    NonAcgt { pos: usize, byte: u8 },
}

pub type Result<T> = std::result::Result<T, KmerError>;