62 template <
typename configuration_t>
64 requires is_type_specialisation_of_v<configuration_t, seqan3::configuration>
87 template <std::ranges::forward_range query_t>
101 errors.substitution = errors.insertion = errors.deletion = errors.total;
104 errors.total = std::min<uint32_t>(255, errors.substitution + errors.insertion + errors.deletion);
108 if (errors.substitution > errors.total)
109 throw std::invalid_argument{
"The substitution error threshold is higher than the total error threshold."};
110 if (errors.insertion > errors.total)
111 throw std::invalid_argument{
"The insertion error threshold is higher than the total error threshold."};
112 if (errors.deletion > errors.total)
113 throw std::invalid_argument{
"The deletion error threshold is higher than the total error threshold."};
135 [[maybe_unused]]
size_t const query_size)
144 if (0.0 > error.get() || error.get() > 1.0)
148 uint8_t
const calculated_error_count =
std::clamp(error.get() * query_size, 0.0, 255.0);
149 return calculated_error_count;
Configuration element that represents the number or rate of deletion errors.
Definition: max_error.hpp:169
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
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:127
Configuration element that represents the number or rate of substitution errors.
Definition: max_error.hpp:80
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:83
Configuration element that represents the number or rate of total errors.
Definition: max_error.hpp:36
std::variant< error_count, error_rate > error
The error count or error rate.
Definition: max_error.hpp:39
constexpr size_t size
The size of a type pack.
Definition: traits.hpp:150
The internal SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
Adaptations of concepts from the Ranges TS.
Provides data structures used by different search algorithms.
Provides seqan3::detail::search_traits.
Provides the function max_error_counts if inherited by a search algorithm.
Definition: policy_max_error.hpp:27
policy_max_error()=default
Defaulted.
~policy_max_error()=default
Defaulted.
policy_max_error & operator=(policy_max_error const &)=default
Defaulted.
policy_max_error(policy_max_error const &)=default
Defaulted.
policy_max_error(policy_max_error &&)=default
Defaulted.
search_cfg::max_error_substitution substitution
The substitution errors set by the user.
Definition: policy_max_error.hpp:32
policy_max_error(configuration_t const &config)
Initialises the policy with the given configuration.
Definition: policy_max_error.hpp:66
search_cfg::max_error_deletion deletion
The deletion errors set by the user.
Definition: policy_max_error.hpp:36
policy_max_error & operator=(policy_max_error &&)=default
Defaulted.
bool has_max_error_total
Flag indicating if max error total was given.
Definition: policy_max_error.hpp:41
auto max_error_counts(query_t &&query)
Returns a detail::search_param object filled by the information from the configuration.
Definition: policy_max_error.hpp:88
search_cfg::max_error_insertion insertion
The insertion errors set by the user.
Definition: policy_max_error.hpp:34
search_cfg::max_error_total total
The total errors set by the user.
Definition: policy_max_error.hpp:30
uint8_t to_error_count(std::variant< search_cfg::error_count, search_cfg::error_rate > const &error_variant, [[maybe_unused]] size_t const query_size)
Returns a uint8_t object directly given by the search_cfg::error_count or calculated by the search_cf...
Definition: policy_max_error.hpp:134
bool only_max_error_total
Flag indicating if only max error was given.
Definition: policy_max_error.hpp:39
Object grouping numbers of errors for different kind of error types.
Definition: search_common.hpp:24
A collection of traits extracted from the search configuration.
Definition: search_traits.hpp:34
A strong type of underlying type uint8_t that represents the number of errors.
Definition: max_error_common.hpp:31