SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
max_error.hpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
2// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
3// SPDX-License-Identifier: BSD-3-Clause
4
12#pragma once
13
14#include <variant>
15
20
21namespace seqan3::search_cfg
22{
34{
35public:
38
42 max_error_total() = default;
43 max_error_total(max_error_total const &) = default;
47 ~max_error_total() = default;
48
52 constexpr explicit max_error_total(error_count error) : error{std::move(error)}
53 {}
54
58 constexpr explicit max_error_total(error_rate error) : error{std::move(error)}
59 {}
61
64 static constexpr detail::search_config_id id{detail::search_config_id::max_error_total};
65};
66
79{
80public:
83
93
97 constexpr explicit max_error_substitution(error_count error) : error{std::move(error)}
98 {}
99
103 constexpr explicit max_error_substitution(error_rate error) : error{std::move(error)}
104 {}
106
109 static constexpr detail::search_config_id id{detail::search_config_id::max_error_substitution};
110};
111
124{
125public:
128
138
142 constexpr explicit max_error_insertion(error_count error) : error{std::move(error)}
143 {}
144
148 constexpr explicit max_error_insertion(error_rate error) : error{std::move(error)}
149 {}
151
154 static constexpr detail::search_config_id id{detail::search_config_id::max_error_insertion};
155};
156
170{
171public:
174
178 max_error_deletion() = default;
184
188 constexpr explicit max_error_deletion(error_count error) : error{std::move(error)}
189 {}
190
194 constexpr explicit max_error_deletion(error_rate error) : error{std::move(error)}
195 {}
197
200 static constexpr detail::search_config_id id{detail::search_config_id::max_error_deletion};
201};
202
203} // namespace seqan3::search_cfg
Configuration element that represents the number or rate of deletion errors.
Definition max_error.hpp:170
max_error_deletion & operator=(max_error_deletion &&)=default
Defaulted.
constexpr max_error_deletion(error_count error)
Initialises the deletion error with the given seqan3::search_cfg::error_count.
Definition max_error.hpp:188
max_error_deletion(max_error_deletion &&)=default
Defaulted.
max_error_deletion(max_error_deletion const &)=default
Defaulted.
constexpr max_error_deletion(error_rate error)
Initialises the deletion error with the given seqan3::search_cfg::error_rate.
Definition max_error.hpp:194
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:173
Configuration element that represents the number or rate of insertion errors.
Definition max_error.hpp:124
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
constexpr 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 const &)=default
Defaulted.
max_error_insertion & operator=(max_error_insertion &&)=default
Defaulted.
constexpr max_error_insertion(error_count error)
Initialises the insertion error with the given seqan3::search_cfg::error_count.
Definition max_error.hpp:142
Configuration element that represents the number or rate of substitution errors.
Definition max_error.hpp:79
max_error_substitution & operator=(max_error_substitution &&)=default
Defaulted.
constexpr max_error_substitution(error_count error)
Initialises the substitution error with the given seqan3::search_cfg::error_count.
Definition max_error.hpp:97
max_error_substitution(max_error_substitution const &)=default
Defaulted.
constexpr max_error_substitution(error_rate error)
Initialises the substitution error with the given seqan3::search_cfg::error_rate.
Definition max_error.hpp:103
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:82
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:34
max_error_total & operator=(max_error_total const &)=default
Defaulted.
constexpr max_error_total(error_count error)
Initialises the total error with the given seqan3::search_cfg::error_count.
Definition max_error.hpp:52
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:37
max_error_total & operator=(max_error_total &&)=default
Defaulted.
constexpr max_error_total(error_rate error)
Initialises the total error with the given seqan3::search_cfg::error_rate.
Definition max_error.hpp:58
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 compatibility matrix for search configurations.
Provides data structures used by different search algorithms.
Adds pipe interface to configuration elements.
Definition pipeable_config_element.hpp:29
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
Hide me