SeqAn3 3.1.0-rc.2
The Modern C++ library for sequence analysis.
hit.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
16#pragma once
17
18#include <variant>
19
24
25namespace seqan3::search_cfg
26{
27
33{
34public:
38 constexpr hit_all() = default;
39 constexpr hit_all(hit_all const &) = default;
40 constexpr hit_all(hit_all &&) = default;
41 constexpr hit_all & operator=(hit_all const &) = default;
42 constexpr hit_all & operator=(hit_all &&) = default;
43 ~hit_all() = default;
44
46
50};
51
57{
58public:
62 constexpr hit_all_best() = default;
63 constexpr hit_all_best(hit_all_best const &) = default;
64 constexpr hit_all_best(hit_all_best &&) = default;
65 constexpr hit_all_best & operator=(hit_all_best const &) = default;
66 constexpr hit_all_best & operator=(hit_all_best &&) = default;
67 ~hit_all_best() = default;
68
70
74};
75
81{
82public:
86 constexpr hit_single_best() = default;
87 constexpr hit_single_best(hit_single_best const &) = default;
88 constexpr hit_single_best(hit_single_best &&) = default;
89 constexpr hit_single_best & operator=(hit_single_best const &) = default;
90 constexpr hit_single_best & operator=(hit_single_best &&) = default;
91 ~hit_single_best() = default;
92
94
98};
99
106{
107public:
109 uint8_t stratum{};
110
114 constexpr hit_strata() = default;
115 constexpr hit_strata(hit_strata const &) = default;
116 constexpr hit_strata(hit_strata &&) = default;
117 constexpr hit_strata & operator=(hit_strata const &) = default;
118 constexpr hit_strata & operator=(hit_strata &&) = default;
119 ~hit_strata() = default;
120
124 hit_strata(uint32_t stratum) : stratum{static_cast<uint8_t>(stratum)}
125 {}
127
131};
132
138{
139public:
146
150 hit() = default;
151 hit(hit const &) = default;
152 hit(hit &&) = default;
153 hit & operator=(hit const &) = default;
154 hit & operator=(hit &&) = default;
155 ~hit() = default;
156
167 template <typename hit_config_t>
169 requires pack_traits::contains<hit_config_t, hit_all, hit_all_best, hit_single_best, hit_strata>
171 explicit hit(hit_config_t hit_config) noexcept : hit_variant{std::move(hit_config)}
172 {}
173
175 template <typename hit_config_t>
177 requires pack_traits::contains<hit_config_t, hit_all, hit_all_best, hit_single_best, hit_strata>
179 hit & operator=(hit_config_t hit_config) noexcept
180 {
181 hit_variant = std::move(hit_config);
182 return *this;
183 }
185
188
192};
193
194} // namespace seqan3::search_cfg
Configuration element to receive all hits with the lowest number of errors within the error bounds.
Definition: hit.hpp:57
constexpr hit_all_best(hit_all_best const &)=default
Defaulted.
constexpr hit_all_best(hit_all_best &&)=default
Defaulted.
constexpr hit_all_best()=default
Defaulted.
~hit_all_best()=default
Defaulted.
constexpr hit_all_best & operator=(hit_all_best const &)=default
Defaulted.
constexpr hit_all_best & operator=(hit_all_best &&)=default
Defaulted.
Configuration element to receive all hits within the error bounds.
Definition: hit.hpp:33
constexpr hit_all & operator=(hit_all const &)=default
Defaulted.
constexpr hit_all & operator=(hit_all &&)=default
Defaulted.
constexpr hit_all()=default
Defaulted.
constexpr hit_all(hit_all &&)=default
Defaulted.
constexpr hit_all(hit_all const &)=default
Defaulted.
~hit_all()=default
Defaulted.
Configuration element to receive a single best hit with the lowest number of errors within the error ...
Definition: hit.hpp:81
constexpr hit_single_best & operator=(hit_single_best const &)=default
Defaulted.
~hit_single_best()=default
Defaulted.
constexpr hit_single_best()=default
Defaulted.
constexpr hit_single_best(hit_single_best &&)=default
Defaulted.
constexpr hit_single_best(hit_single_best const &)=default
Defaulted.
constexpr hit_single_best & operator=(hit_single_best &&)=default
Defaulted.
Configuration element to receive all hits with the best number of errors plus the given stratum....
Definition: hit.hpp:106
constexpr hit_strata(hit_strata const &)=default
Defaulted.
constexpr hit_strata(hit_strata &&)=default
Defaulted.
constexpr hit_strata & operator=(hit_strata &&)=default
Defaulted.
constexpr hit_strata & operator=(hit_strata const &)=default
Defaulted.
uint8_t stratum
The stratum value [default: 0].
Definition: hit.hpp:109
constexpr hit_strata()=default
Defaulted.
~hit_strata()=default
Defaulted.
hit_strata(uint32_t stratum)
Initialises the strata config.
Definition: hit.hpp:124
A dynamic configuration element to configure the hit strategy at runtime.
Definition: hit.hpp:138
hit & operator=(hit &&)=default
Defaulted.
hit(hit &&)=default
Defaulted.
hit_variant_type hit_variant
A std::variant over the valid hit configuration elements.
Definition: hit.hpp:187
hit(hit_config_t hit_config) noexcept
Sets the given configuration element to the dynamic hit configuration element.
Definition: hit.hpp:171
hit & operator=(hit_config_t hit_config) noexcept
Sets the given configuration element to the dynamic hit configuration element.
Definition: hit.hpp:179
~hit()=default
Defaulted.
hit(hit const &)=default
Defaulted.
hit & operator=(hit const &)=default
Defaulted.
hit()=default
Defaulted.
Provides seqan3::detail::empty_type.
search_config_id
Specifies an id for every configuration element.
Definition: detail.hpp:42
@ hit
Identifier for the hit configuration (all, all_best, single_best, strata).
A special sub namespace for the search configurations.
Provides seqan3::pipeable_config_element.
Provides compatibility matrix for search configurations.
Adds pipe interface to configuration elements.
Definition: pipeable_config_element.hpp:30
Provides various traits for template packs.