SeqAn3 3.2.0
The Modern C++ library for sequence analysis.
seqan3::search_cfg::max_error_total Class Reference

Configuration element that represents the number or rate of total errors. More...

#include <seqan3/search/configuration/max_error.hpp>

+ Inheritance diagram for seqan3::search_cfg::max_error_total:

Public Member Functions

Constructors, destructor and assignment
 max_error_total ()=default
 Defaulted.
 
 max_error_total (max_error_total const &)=default
 Defaulted.
 
 max_error_total (max_error_total &&)=default
 Defaulted.
 
max_error_totaloperator= (max_error_total const &)=default
 Defaulted.
 
max_error_totaloperator= (max_error_total &&)=default
 Defaulted.
 
 ~max_error_total ()=default
 Defaulted.
 
constexpr max_error_total (error_count error)
 Initialises the total error with the given seqan3::search_cfg::error_count. More...
 
constexpr max_error_total (error_rate error)
 Initialises the total error with the given seqan3::search_cfg::error_rate. More...
 

Public Attributes

std::variant< error_count, error_rateerror {error_count{0}}
 The error count or error rate.
 

Detailed Description

Configuration element that represents the number or rate of total errors.

See also
Configuration

This configuration element can be used to determine the number or rate of total errors that are supported.

Example

int main()
{
// Allow 1 error of any type.
// Do not allow substitutions. Allow at most 1 error.
// Sets total errors to 2.
// Allow 10% errors of any type.
// Do not allow substitutions. Allow at most 10% errors.
// Sets total errors to 20%.
// Mixed error rate & count: Allow 2 insertions and or 2 deletions and 20% errors in total.
return 0;
}
Collection of elements to configure an algorithm.
Definition: configuration.hpp:45
Configuration element that represents the number or rate of deletion errors.
Definition: max_error.hpp:173
Configuration element that represents the number or rate of insertion errors.
Definition: max_error.hpp:127
Configuration element that represents the number or rate of substitution errors.
Definition: max_error.hpp:82
Configuration element that represents the number or rate of total errors.
Definition: max_error.hpp:37
Provides seqan3::configuration and utility functions.
Provides the configuration for maximum number of errors for all error types.
A strong type of underlying type uint8_t that represents the number of errors.
Definition: max_error_common.hpp:32
A strong type of underlying type double that represents the rate of errors.
Definition: max_error_common.hpp:46

Constructor & Destructor Documentation

◆ max_error_total() [1/2]

constexpr seqan3::search_cfg::max_error_total::max_error_total ( error_count  error)
inlineexplicitconstexpr

Initialises the total error with the given seqan3::search_cfg::error_count.

Parameters
[in]errorThe maximal number of total errors allowed in the search.

◆ max_error_total() [2/2]

constexpr seqan3::search_cfg::max_error_total::max_error_total ( error_rate  error)
inlineexplicitconstexpr

Initialises the total error with the given seqan3::search_cfg::error_rate.

Parameters
[in]errorThe maximal total error rate allowed in the search.

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