Trait debruijn::filter::KmerSummarizer

pub trait KmerSummarizer<DI, DO> {
    fn summarize<K, F: Iterator<Item = (K, Exts, DI)>>(
        &self, 
        items: F
    ) -> (bool, Exts, DO);
}

Implement this trait to control how multiple observations of a kmer are carried forward into a DeBruijn graph.

Required methods

fn summarize<K, F: Iterator<Item = (K, Exts, DI)>>(
    &self,
    items: F
) -> (bool, Exts, DO)

The input items is an iterator over kmer observations. Input observation is a tuple of (kmer, extensions, data). The summarize function inspects the data and returns a tuple indicating:

• whether this kmer passes the filtering criteria (e.g. is there a sufficient number of observation)
• the accumulated Exts of the kmer
• a summary data object of type DO that will be used as a color annotation in the DeBruijn graph.

Loading content...

Implementors

impl<D> KmerSummarizer<D, u16> for CountFilter

fn summarize<K, F: Iterator<Item = (K, Exts, D)>>(
    &self,
    items: F
) -> (bool, Exts, u16)

impl<D: Eq + Ord + Hash + Send + Sync + Debug + Clone> KmerSummarizer<D, u32> for CountFilterEqClass<D>

fn summarize<K, F: Iterator<Item = (K, Exts, D)>>(
    &self,
    items: F
) -> (bool, Exts, EqClassIdType)

impl<D: Ord> KmerSummarizer<D, Vec<D>> for CountFilterSet<D>

fn summarize<K, F: Iterator<Item = (K, Exts, D)>>(
    &self,
    items: F
) -> (bool, Exts, Vec<D>)

Loading content...