Struct MinimizerTuple 

pub struct MinimizerTuple {
    pub minimizer: u64,
    pub pos_in_seq: u64,
    pub pos_in_kmer: u8,
    pub num_kmers_in_super_kmer: u8,
}

A minimizer tuple representing a k-mer’s minimizer and its position

This is the fundamental unit for indexing. Each tuple represents a minimizer occurrence in the input and tracks where it appears.

Canonical Mode Orientation Handling

In canonical mode, when a k-mer’s reverse complement minimizer is smaller than the forward minimizer, we use the RC minimizer BUT adjust pos_in_kmer to reflect the position in the forward k-mer:

If RC minimizer is chosen:
  pos_in_kmer = (k - m) - original_rc_pos

This elegantly encodes orientation implicitly without needing a separate flag. The minimizer position is always relative to the forward k-mer representation.

Fields

minimizer: u64

The minimizer value (m-mer)

pos_in_seq: u64

Position of the minimizer in the sequence (in bases from string start)

pos_in_kmer: u8

Position of the minimizer within the k-mer (0 to k-m)

In canonical mode, this is ALWAYS relative to the forward k-mer, even when the RC minimizer is chosen (adjusted accordingly).

num_kmers_in_super_kmer: u8

Number of consecutive k-mers that share this minimizer (super-k-mer size)

Implementations

impl MinimizerTuple

pub fn new(minimizer: u64, pos_in_seq: u64, pos_in_kmer: u8) -> Self

Create a new minimizer tuple

Trait Implementations

impl Clone for MinimizerTuple

fn clone(&self) -> MinimizerTuple

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MinimizerTuple

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

Formats the value using the given formatter.

impl Ord for MinimizerTuple

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MinimizerTuple

fn eq(&self, other: &MinimizerTuple) -> 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.

impl PartialOrd for MinimizerTuple

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MinimizerTuple

impl Eq for MinimizerTuple

impl StructuralPartialEq for MinimizerTuple