SeqAn3  3.0.2
The Modern C++ library for sequence analysis.
max_error.hpp
Go to the documentation of this file.
1 // -----------------------------------------------------------------------------------------------------
2 // Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
3 // Copyright (c) 2016-2020, 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 
24 namespace seqan3::search_cfg
25 {
35 class max_error_total : public pipeable_config_element<max_error_total>
36 {
37 public:
40 
44  max_error_total() = default;
45  max_error_total(max_error_total const &) = default;
47  max_error_total & operator=(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 
79 class max_error_substitution : public pipeable_config_element<max_error_substitution>
80 {
81 public:
84 
88  max_error_substitution() = default;
94 
99  {}
100 
105  {}
107 
110  static constexpr detail::search_config_id id{detail::search_config_id::max_error_substitution};
111 };
112 
123 class max_error_insertion : public pipeable_config_element<max_error_insertion>
124 {
125 public:
128 
132  max_error_insertion() = default;
137  ~max_error_insertion() = default;
138 
143  {}
144 
149  {}
151 
154  static constexpr detail::search_config_id id{detail::search_config_id::max_error_insertion};
155 };
156 
168 class max_error_deletion : public pipeable_config_element<max_error_deletion>
169 {
170 public:
173 
177  max_error_deletion() = default;
182  ~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
seqan3::search_cfg::max_error_substitution::operator=
max_error_substitution & operator=(max_error_substitution &&)=default
Defaulted.
seqan3::search_cfg::max_error_deletion::error
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:172
seqan3::search_cfg::max_error_total::error
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:39
seqan3::search_cfg::max_error_total::max_error_total
max_error_total(error_count error)
Initialises the total error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:54
seqan3::search_cfg::max_error_substitution::max_error_substitution
max_error_substitution(max_error_substitution &&)=default
Defaulted.
seqan3::search_cfg::max_error_total::max_error_total
max_error_total(error_rate error)
Initialises the total error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:60
seqan3::search_cfg::max_error_total::~max_error_total
~max_error_total()=default
Defaulted.
seqan3::search_cfg::max_error_total::operator=
max_error_total & operator=(max_error_total const &)=default
Defaulted.
seqan3::search_cfg::max_error_insertion::max_error_insertion
max_error_insertion(error_rate error)
Initialises the insertion error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:148
seqan3::search_cfg::max_error_substitution
Configuration element that represents the number or rate of substitution errors.
Definition: max_error.hpp:80
seqan3::search_cfg::max_error_total
Configuration element that represents the number or rate of total errors.
Definition: max_error.hpp:36
detail.hpp
Provides compatibility matrix for search configurations.
seqan3::search_cfg::max_error_deletion::max_error_deletion
max_error_deletion(max_error_deletion &&)=default
Defaulted.
seqan3::search_cfg::max_error_deletion::max_error_deletion
max_error_deletion(error_count error)
Initialises the deletion error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:187
pipeable_config_element.hpp
Provides seqan3::pipeable_config_element.
seqan3::search_cfg::max_error_insertion::max_error_insertion
max_error_insertion(max_error_insertion const &)=default
Defaulted.
seqan3::search_cfg::max_error_deletion::max_error_deletion
max_error_deletion()=default
Defaulted.
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
seqan3::search_cfg::max_error_deletion::max_error_deletion
max_error_deletion(max_error_deletion const &)=default
Defaulted.
seqan3::search_cfg::max_error_substitution::~max_error_substitution
~max_error_substitution()=default
Defaulted.
seqan3::search_cfg
A special sub namespace for the search configurations.
seqan3::search_cfg::max_error_insertion::operator=
max_error_insertion & operator=(max_error_insertion &&)=default
Defaulted.
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::search_cfg::max_error_insertion::error
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:127
seqan3::views::move
auto const move
A view that turns lvalue-references into rvalue-references.
Definition: move.hpp:68
seqan3::search_cfg::max_error_insertion::operator=
max_error_insertion & operator=(max_error_insertion const &)=default
Defaulted.
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
seqan3::search_cfg::max_error_deletion::operator=
max_error_deletion & operator=(max_error_deletion const &)=default
Defaulted.
seqan3::search_cfg::max_error_substitution::max_error_substitution
max_error_substitution(max_error_substitution const &)=default
Defaulted.
seqan3::search_cfg::max_error_substitution::max_error_substitution
max_error_substitution(error_rate error)
Initialises the substitution error with the given seqan3::search_cfg::error_rate.
Definition: max_error.hpp:104
seqan3::search_cfg::max_error_total::operator=
max_error_total & operator=(max_error_total &&)=default
Defaulted.
seqan3::search_cfg::max_error_substitution::max_error_substitution
max_error_substitution(error_count error)
Initialises the substitution error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:98
seqan3::search_cfg::max_error_total::max_error_total
max_error_total(max_error_total &&)=default
Defaulted.
seqan3::search_cfg::max_error_substitution::max_error_substitution
max_error_substitution()=default
Defaulted.
seqan3::search_cfg::max_error_deletion::max_error_deletion
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_common.hpp
Provides the error types for maximum number of errors.
seqan3::search_cfg::max_error_insertion::max_error_insertion
max_error_insertion()=default
Defaulted.
seqan3::search_cfg::max_error_total::max_error_total
max_error_total()=default
Defaulted.
search_common.hpp
Provides data structures used by different search algorithms.
seqan3::search_cfg::max_error_insertion::~max_error_insertion
~max_error_insertion()=default
Defaulted.
seqan3::search_cfg::max_error_insertion::max_error_insertion
max_error_insertion(error_count error)
Initialises the insertion error with the given seqan3::search_cfg::error_count.
Definition: max_error.hpp:142
seqan3::search_cfg::max_error_deletion::operator=
max_error_deletion & operator=(max_error_deletion &&)=default
Defaulted.
seqan3::search_cfg::max_error_deletion::~max_error_deletion
~max_error_deletion()=default
Defaulted.
seqan3::search_cfg::max_error_total::max_error_total
max_error_total(max_error_total const &)=default
Defaulted.
seqan3::search_cfg::max_error_substitution::error
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:83
seqan3::search_cfg::max_error_substitution::operator=
max_error_substitution & operator=(max_error_substitution const &)=default
Defaulted.
seqan3::search_cfg::max_error_insertion::max_error_insertion
max_error_insertion(max_error_insertion &&)=default
Defaulted.
variant