SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
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.
 
constexpr max_error_substitution (error_count error)
 Initialises the substitution error with the given seqan3::search_cfg::error_count.
 
constexpr max_error_substitution (error_rate error)
 Initialises the substitution error with the given seqan3::search_cfg::error_rate.
 

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.

See also
Configuration

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

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
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:42
A "pretty printer" for most SeqAn data structures and related types.
Definition debug_stream_type.hpp:79
Configuration element that represents the number or rate of deletion errors.
Definition max_error.hpp:170
Configuration element that represents the number or rate of insertion errors.
Definition max_error.hpp:124
Configuration element that represents the number or rate of substitution errors.
Definition max_error.hpp:79
Configuration element that represents the number or rate of total errors.
Definition max_error.hpp:34
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:29
A strong type of underlying type double that represents the rate of errors.
Definition max_error_common.hpp:43

Constructor & Destructor Documentation

◆ max_error_substitution() [1/2]

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

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]

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

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:
Hide me