SeqAn3 3.1.0-rc.2
The Modern C++ library for sequence analysis.
max_error.hpp
Go to the documentation of this file.
1// -----------------------------------------------------------------------------------------------------
2// Copyright (c) 2006-2021, Knut Reinert & Freie Universität Berlin
3// Copyright (c) 2016-2021, Knut Reinert & MPI für molekulare Genetik
4// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
5// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
6// -----------------------------------------------------------------------------------------------------
7
15#pragma once
16
17#include <variant>
18
23
24namespace seqan3::search_cfg
25{
36{
37public:
40
44 max_error_total() = default;
45 max_error_total(max_error_total const &) = default;
49 ~max_error_total() = default;
50
55 {}
56
61 {}
63
66 static constexpr detail::search_config_id id{detail::search_config_id::max_error_total};
67};
68
80{
81public:
84
94
99 {}
100
105 {}
107
110 static constexpr detail::search_config_id id{detail::search_config_id::max_error_substitution};
111};
112
124{
125public:
128
138
143 {}
144
149 {}
151
154 static constexpr detail::search_config_id id{detail::search_config_id::max_error_insertion};
155};
156
169{
170public:
173
177 max_error_deletion() = default;
183
188 {}
189
194 {}
196
199 static constexpr detail::search_config_id id{detail::search_config_id::max_error_deletion};
200};
201
202} // namespace seqan3::search_cfg
Configuration element that represents the number or rate of deletion errors.
Definition: max_error.hpp:169
max_error_deletion & operator=(max_error_deletion &&)=default
Defaulted.
max_error_deletion(error_rate error)
Initialises the deletion error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:193
max_error_deletion(max_error_deletion &&)=default
Defaulted.
max_error_deletion(error_count error)
Initialises the deletion error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:187
max_error_deletion(max_error_deletion const &)=default
Defaulted.
max_error_deletion & operator=(max_error_deletion const &)=default
Defaulted.
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:172
Configuration element that represents the number or rate of insertion errors.
Definition: max_error.hpp:124
max_error_insertion(error_count error)
Initialises the insertion error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:142
max_error_insertion(max_error_insertion &&)=default
Defaulted.
max_error_insertion(max_error_insertion const &)=default
Defaulted.
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:127
max_error_insertion & operator=(max_error_insertion const &)=default
Defaulted.
max_error_insertion(error_rate error)
Initialises the insertion error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:148
max_error_insertion & operator=(max_error_insertion &&)=default
Defaulted.
Configuration element that represents the number or rate of substitution errors.
Definition: max_error.hpp:80
max_error_substitution & operator=(max_error_substitution &&)=default
Defaulted.
max_error_substitution(error_count error)
Initialises the substitution error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:98
max_error_substitution(max_error_substitution const &)=default
Defaulted.
max_error_substitution(max_error_substitution &&)=default
Defaulted.
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:83
max_error_substitution(error_rate error)
Initialises the substitution error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:104
max_error_substitution & operator=(max_error_substitution const &)=default
Defaulted.
Configuration element that represents the number or rate of total errors.
Definition: max_error.hpp:36
max_error_total & operator=(max_error_total const &)=default
Defaulted.
max_error_total(error_count error)
Initialises the total error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:54
max_error_total(max_error_total &&)=default
Defaulted.
~max_error_total()=default
Defaulted.
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:39
max_error_total & operator=(max_error_total &&)=default
Defaulted.
max_error_total(error_rate error)
Initialises the total error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:60
max_error_total(max_error_total const &)=default
Defaulted.
max_error_total()=default
Defaulted.
Provides the error types for maximum number of errors.
A special sub namespace for the search configurations.
SeqAn specific customisations in the standard namespace.
Provides seqan3::pipeable_config_element.
Provides data structures used by different search algorithms.
Adds pipe interface to configuration elements.
Definition: pipeable_config_element.hpp:30
A strong type of underlying type uint8_t that represents the number of errors.
Definition: max_error_common.hpp:31
A strong type of underlying type double that represents the rate of errors.
Definition: max_error_common.hpp:45