SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
seqan3::search_cfg::max_error_substitution Class Reference

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

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

+ Inheritance diagram for seqan3::search_cfg::max_error_substitution:

Public Member Functions

Constructors, destructor and assignment
 max_error_substitution ()=default
 Defaulted.
 
 max_error_substitution (max_error_substitution const &)=default
 Defaulted.
 
 max_error_substitution (max_error_substitution &&)=default
 Defaulted.
 
max_error_substitutionoperator= (max_error_substitution const &)=default
 Defaulted.
 
max_error_substitutionoperator= (max_error_substitution &&)=default
 Defaulted.
 
 ~max_error_substitution ()=default
 Defaulted.
 
 max_error_substitution (error_count error)
 Initialises the substitution error with the given seqan3::search_cfg::error_count. More...
 
 max_error_substitution (error_rate error)
 Initialises the substitution 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 substitution errors.

This configuration element can be used to determine the number or rate of substitution errors that are supported. A substitution corresponds to diverging bases between text and query for a certain position.

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;
}

Constructor & Destructor Documentation

◆ max_error_substitution() [1/2]

seqan3::search_cfg::max_error_substitution::max_error_substitution ( error_count  error)
inlineexplicit

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

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

◆ max_error_substitution() [2/2]

seqan3::search_cfg::max_error_substitution::max_error_substitution ( error_rate  error)
inlineexplicit

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

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

The documentation for this class was generated from the following file:
seqan3::search_cfg::max_error_substitution
Configuration element that represents the number or rate of substitution errors.
Definition: max_error.hpp:80
configuration.hpp
Provides seqan3::detail::configuration and utility functions.
seqan3::search_cfg::max_error_total
Configuration element that represents the number or rate of total errors.
Definition: max_error.hpp:36
seqan3::search_cfg::max_error_deletion
Configuration element that represents the number or rate of deletion errors.
Definition: max_error.hpp:169
seqan3::search_cfg::max_error_insertion
Configuration element that represents the number or rate of insertion errors.
Definition: max_error.hpp:124
max_error.hpp
Provides the configuration for maximum number of errors for all error types.
seqan3::search_cfg::error_rate
A strong type of underlying type double that represents the rate of errors.
Definition: max_error_common.hpp:44
seqan3::configuration
Collection of elements to configure an algorithm.
Definition: configuration.hpp:82
seqan3::search_cfg::error_count
A strong type of underlying type uint8_t that represents the number of errors.
Definition: max_error_common.hpp:30