SeqAn3  3.0.1
The Modern C++ library for sequence analysis.
mode.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 
14 #pragma once
15 
21 
22 
23 namespace seqan3::detail
24 {
25 
28 struct search_mode_all {};
31 struct search_mode_all_best {};
34 struct search_mode_best {};
35 
36 } // namespace seqan3::detail
37 
38 namespace seqan3::search_cfg
39 {
40 
43 inline detail::search_mode_all constexpr all;
46 inline detail::search_mode_all_best constexpr all_best;
49 inline detail::search_mode_best constexpr best;
50 
57 struct strata : detail::strong_type<uint8_t, strata, detail::strong_type_skill::convert>
58 {
59  using detail::strong_type<uint8_t, strata, detail::strong_type_skill::convert>::strong_type;
60 };
61 
79 template <typename mode_t>
81  requires std::same_as<remove_cvref_t<mode_t>, detail::search_mode_all> ||
82  std::same_as<remove_cvref_t<mode_t>, detail::search_mode_all_best> ||
83  std::same_as<remove_cvref_t<mode_t>, detail::search_mode_best> ||
84  std::same_as<remove_cvref_t<mode_t>, strata>
86 struct mode : public pipeable_config_element<mode<mode_t>, mode_t>
87 {
90  static constexpr detail::search_config_id id{detail::search_config_id::mode};
91 };
92 
98 template <typename mode_t>
102 } // namespace seqan3::search_cfg
Provides basic data structure for strong types.
detail::search_mode_best constexpr best
Configuration element to receive one best hit (with the lowest number of errors). ...
Definition: mode.hpp:49
Provides compatibility matrix for search configurations.
Adds pipe interface to configuration elements.
Definition: pipeable_config_element.hpp:30
detail::search_mode_all_best constexpr all_best
Configuration element to receive all hits within the lowest number of errors.
Definition: mode.hpp:46
A special sub namespace for the search configurations.
Configuration element to receive all hits with the best number of errors plus the strata value...
Definition: mode.hpp:57
detail::search_mode_all constexpr all
Configuration element to receive all hits within the error bounds.
Definition: mode.hpp:43
Configuration element to determine the search mode.
Definition: mode.hpp:86
Provides seqan3::pipeable_config_element.
Definition: aligned_sequence_concept.hpp:36
Provides various type traits on generic types.
Provides seqan3::detail::configuration and utility functions.
The concept std::same_as<T, U> is satisfied if and only if T and U denote the same type...