SeqAn3 3.1.0
The Modern C++ library for sequence analysis.
seqan3::search_cfg::max_error_deletion Class Reference

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

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

+ Inheritance diagram for seqan3::search_cfg::max_error_deletion:

Public Member Functions

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

See also
Configuration

This configuration element can be used to determine the number or rate of deletion errors that are supported. A deletion corresponds to a base deleted from the query sequence that does occur in the text. Deletions at the beginning and at the end of the sequence are not considered during a search.

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:47

Constructor & Destructor Documentation

◆ max_error_deletion() [1/2]

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

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

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

◆ max_error_deletion() [2/2]

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

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

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

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