A configuration element for the maximum number of errors across all error types (mismatches, insertions, deletions). This is an upper bound of errors independent from error numbers of specific error types. More...
#include <seqan3/search/configuration/max_error.hpp>
Public Member Functions | |
Constructor, destructor and assignment | |
Defaulted all standard constructor. | |
constexpr | max_error () noexcept=default |
Default constructor. | |
constexpr | max_error (max_error const &) noexcept=default |
Copy constructor. | |
constexpr | max_error (max_error &&) noexcept=default |
Move constructor. | |
constexpr max_error & | operator= (max_error const &) noexcept=default |
Copy assignment. | |
constexpr max_error & | operator= (max_error &&) noexcept=default |
Move assignment. | |
~max_error () noexcept=default | |
Destructor. | |
constexpr | max_error (errors_t &&...errors) noexcept |
Constructs the object from a set of error specifiers. More... | |
Public Attributes | |
std::array< uint8_t, 4 > | value |
The stored config value. | |
Related Functions | |
(Note that these are not member functions.) | |
Type deduction guides | |
max_error () -> max_error<> | |
Deduces empty list of error specifiers. | |
template<typename ... errors_t> | |
max_error (errors_t &&...) -> max_error< remove_cvref_t< errors_t >... > | |
Deduces template arguments from the passed error specifiers. | |
A configuration element for the maximum number of errors across all error types (mismatches, insertions, deletions). This is an upper bound of errors independent from error numbers of specific error types.
An insertion corresponds to a base inserted into the query that does not occur in the text at the position, a deletion corresponds to a base deleted from the query sequence that does occur in the indexed text. Deletions at the beginning and at the end of the sequence are not considered during a search.
|
inlineconstexprnoexcept |
Constructs the object from a set of error specifiers.
errors_t | A template parameter pack with the error types. |
[in] | errors | A pack of error specifiers. |
This configuration can be used to specify the total number of error types. It restricts the number of substitutions, insertions, deletions and total errors within the search to the given values and will behave as follows:
Behaviour | Set all error types to total | Set total to substitution | Set total to insertion | Set total to deletion | Set total to substitution + insertion | Set total to substitution + deletion | Set total to insertion + deletion |
seqan3::search_cfg::total | ✅ | ||||||
seqan3::search_cfg::substitution | ✅ | ✅ | ✅ | ||||
seqan3::search_cfg::insertion | ✅ | ✅ | ✅ | ||||
seqan3::search_cfg::deletion | ✅ | ✅ | ✅ |
If seqan3::search_cfg::total and any other error type are specified, all types are set to the respective values.