kaori::SegmentedBarcodeSearch< num_segments_ >::Options Struct Reference

Optional parameters for a SegmentedBarcodeSearch. More...

#include <BarcodeSearch.hpp>

Public Member Functions
	Options (int max_mismatch_per_segment=0)

Public Attributes
std::array< int, num_segments_ >	max_mismatches
bool	reverse = false
DuplicateAction	duplicates = DuplicateAction::ERROR

Detailed Description

template<int num_segments_>
struct kaori::SegmentedBarcodeSearch< num_segments_ >::Options

Optional parameters for a SegmentedBarcodeSearch.

Constructor & Destructor Documentation

Options()

template<int num_segments_>

kaori::SegmentedBarcodeSearch< num_segments_ >::Options::Options ( int max_mismatch_per_segment = 0 )

inline

Parameters

max_mismatch_per_segment

Maximum number of mismatches per segment. This is used to fill max_mismatches.

Member Data Documentation

duplicates

template<int num_segments_>

DuplicateAction kaori::SegmentedBarcodeSearch< num_segments_ >::Options::duplicates = DuplicateAction::ERROR

How duplicated barcode sequences should be handled.

max_mismatches

template<int num_segments_>

std::array<int, num_segments_> kaori::SegmentedBarcodeSearch< num_segments_ >::Options::max_mismatches

Maximum number of mismatches in each segment for SegmentedBarcodeSearch::search(). All values should be non-negative. Defaults to an all-zero array in the Options() constructor.

reverse

template<int num_segments_>

bool kaori::SegmentedBarcodeSearch< num_segments_ >::Options::reverse = false

Whether to reverse-complement the barcode sequences before indexing them. Note that, even if reverse = true, the segment lengths in the SegmentedBarcodeSearch() constructor and the numbers of mismatches in max_mismatches should still be ordered according to the forward strand.

---

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

• kaori/BarcodeSearch.hpp