kaori
A C++ library for barcode extraction and matching
Loading...
Searching...
No Matches
Public Attributes | List of all members
kaori::CombinatorialBarcodesSingleEnd< max_size, num_variable >::Options Struct Reference

Optional parameters for CombinatorialBarcodeSingleEnd. More...

#include <CombinatorialBarcodesSingleEnd.hpp>

Public Attributes

int max_mismatches = 0
 
bool use_first = true
 
SearchStrand strand = SearchStrand::FORWARD
 
DuplicateAction duplicates = DuplicateAction::ERROR
 

Detailed Description

template<size_t max_size, size_t num_variable>
struct kaori::CombinatorialBarcodesSingleEnd< max_size, num_variable >::Options

Optional parameters for CombinatorialBarcodeSingleEnd.

Member Data Documentation

◆ duplicates

template<size_t max_size, size_t num_variable>
DuplicateAction kaori::CombinatorialBarcodesSingleEnd< max_size, num_variable >::Options::duplicates = DuplicateAction::ERROR

How duplicated barcode sequences should be handled.

◆ max_mismatches

template<size_t max_size, size_t num_variable>
int kaori::CombinatorialBarcodesSingleEnd< max_size, num_variable >::Options::max_mismatches = 0

Maximum number of mismatches allowed across the barcoding element.

◆ strand

template<size_t max_size, size_t num_variable>
SearchStrand kaori::CombinatorialBarcodesSingleEnd< max_size, num_variable >::Options::strand = SearchStrand::FORWARD

Strand(s) of the read sequence to search for the barcoding element.

◆ use_first

template<size_t max_size, size_t num_variable>
bool kaori::CombinatorialBarcodesSingleEnd< max_size, num_variable >::Options::use_first = true
Parameters
Whetherto search only for the first match. If false, the handler will search for the best match (i.e., fewest mismatches) instead.

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