SeqAn3
The Modern C++ library for sequence analysis.
mode.hpp
Go to the documentation of this file.
1 // -----------------------------------------------------------------------------------------------------
2 // Copyright (c) 2006-2019, Knut Reinert & Freie Universität Berlin
3 // Copyright (c) 2016-2019, 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 
26 namespace seqan3::detail
27 {
28 
30 struct search_mode_all {};
32 struct search_mode_all_best {};
34 struct search_mode_best {};
35 
36 } // namespace seqan3::detail
37 
38 namespace seqan3::search_cfg
39 {
40 
42 inline detail::search_mode_all constexpr all;
44 inline detail::search_mode_all_best constexpr all_best;
46 inline detail::search_mode_best constexpr best;
47 
54 struct strata : detail::strong_type<uint8_t, strata, detail::strong_type_skill::convert>
55 {
56  using detail::strong_type<uint8_t, strata, detail::strong_type_skill::convert>::strong_type;
57 };
58 
76 template <typename mode_t>
78  requires std::Same<remove_cvref_t<mode_t>, detail::search_mode_all> ||
79  std::Same<remove_cvref_t<mode_t>, detail::search_mode_all_best> ||
80  std::Same<remove_cvref_t<mode_t>, detail::search_mode_best> ||
81  std::Same<remove_cvref_t<mode_t>, strata>
83 struct mode : public pipeable_config_element<mode<mode_t>, mode_t>
84 {
87  static constexpr detail::search_config_id id{detail::search_config_id::mode};
88 };
89 
95 template <typename mode_t>
99 } // namespace seqan3::search_cfg
100 
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:46
Adds pipe interface to configuration elements.
Definition: pipeable_config_element.hpp:30
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:54
Provides compatibility matrix for search configurations.
Configuration element to determine the search mode.
Definition: mode.hpp:83
detail::search_mode_all_best constexpr all_best
Configuration element to receive all hits within the lowest number of errors.
Definition: mode.hpp:44
Provides seqan3::pipeable_config_element.
The concept std::Same<T, U> is satisfied if and only if T and U denote the same type.
Definition: aligned_sequence_concept.hpp:35
detail::search_mode_all constexpr all
Configuration element to receive all hits within the error bounds.
Definition: mode.hpp:42
Provides various type traits on generic types.
Provides seqan3::detail::configuration and utility functions.