Struct Kmer 

pub struct Kmer { /* private fields */ }

K-mer structure that can store both direct and reverse complement representations K-mers are stored in a compact 64-bit representation, with 2 bits per base.

Implementations

impl Kmer

pub fn new(max_size: u32, variant: KmerMode) -> Self

Create a new empty k-mer with specified maximum size and mode

pub fn from_values( kmer_dir: u64, kmer_rc: u64, max_size: u32, cur_size: u32, variant: KmerMode, ) -> Self

Create a k-mer from existing direct and reverse complement values

pub fn reset(&mut self)

Reset the k-mer to empty state

pub fn insert_canonical(&mut self, symbol: u64)

Insert a symbol (base) at the end of the k-mer (canonical mode)

pub fn insert(&mut self, symbol: u64)

Insert a symbol based on the current mode

pub fn data(&self) -> u64

Get the k-mer data based on current mode

pub fn data_canonical(&self) -> u64

Get the canonical k-mer (minimum of direct and reverse complement)

pub fn data_dir(&self) -> u64

Get the direct k-mer

pub fn data_rc(&self) -> u64

Get the reverse complement k-mer

pub fn is_full(&self) -> bool

Check if k-mer is full (reached maximum size)

pub fn get_cur_size(&self) -> u32

Get current size

pub fn get_max_size(&self) -> u32

Get maximum size

pub fn get_symbol(&self, pos: u32) -> u64

Get a symbol at a specific position

pub fn swap_dir_rc(&mut self)

Swap direct and reverse complement representations

pub fn is_dir_oriented(&self) -> bool

Check if the k-mer is in direct orientation (for canonical mode)

Trait Implementations

impl Clone for Kmer

fn clone(&self) -> Kmer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Kmer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Kmer

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.