kaori
A C++ library for barcode extraction and matching
Loading...
Searching...
No Matches
kaori::ScanTemplate< max_size_ >::State Struct Reference

Details on the current match to the read sequence. More...

#include <ScanTemplate.hpp>

Public Attributes

SeqLength position = static_cast<SeqLength>(-1)
 
int forward_mismatches = 0
 
int reverse_mismatches = 0
 
bool finished = false
 

Detailed Description

template<SeqLength max_size_>
struct kaori::ScanTemplate< max_size_ >::State

Details on the current match to the read sequence.

Member Data Documentation

◆ finished

template<SeqLength max_size_>
bool kaori::ScanTemplate< max_size_ >::State::finished = false

Whether the match is at the end of the read sequence. If true, next() should not be called.

◆ forward_mismatches

template<SeqLength max_size_>
int kaori::ScanTemplate< max_size_ >::State::forward_mismatches = 0

Number of mismatches on the forward strand at the current position. This should only be used after a call to next(), and only if the forward strand is searched.

◆ position

template<SeqLength max_size_>
SeqLength kaori::ScanTemplate< max_size_ >::State::position = static_cast<SeqLength>(-1)

Position of the match to the template on the read sequence. This should only be used after a call to next().

◆ reverse_mismatches

template<SeqLength max_size_>
int kaori::ScanTemplate< max_size_ >::State::reverse_mismatches = 0

Number of mismatches on the reverse strand at the current position. This should only be used after a call to next(), and only if the reverse strand is searched.


The documentation for this struct was generated from the following file: