SeqAn3
concept_pre.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
54 #pragma once
55 
56 #include <seqan3/core/platform.hpp>
57 
58 namespace seqan3
59 {
60 
61 // ------------------------------------------------------------------
62 // seqan3::semi_alphabet_concept
63 // ------------------------------------------------------------------
64 
79 template <typename semi_alphabet_type>
80 struct underlying_rank{};
81 
87 template <typename semi_alphabet_type>
89 
103 template <typename alphabet_type>
104 struct alphabet_size{};
105 
112 template <typename alphabet_type>
114  requires requires (alphabet_type alph) { alphabet_size<alphabet_type>::value; }
116 constexpr auto alphabet_size_v = alphabet_size<alphabet_type>::value;
117 
128 // just implement the interface
129 
141 // just implement the interface
143 
144 // ------------------------------------------------------------------
145 // seqan3::alphabet_concept
146 // ------------------------------------------------------------------
147 
163 template <typename alphabet_type>
165 
171 template <typename alphabet_type>
173 
184 // just implement the interface
185 
197 // just implement the interface
198 
200 
201 // ------------------------------------------------------------------
202 // seqan3::rna_structure_concept
203 // ------------------------------------------------------------------
204 
227 template<typename alphabet_type>
229 
235 template<typename alphabet_type>
237  requires requires (alphabet_type alph) { max_pseudoknot_depth<alphabet_type>::value; }
239 constexpr uint8_t max_pseudoknot_depth_v = max_pseudoknot_depth<alphabet_type>::value;
241 
242 } // namespace seqan3
243 
244 // ------------------------------------------------------------------
245 // seqan3::char_adaption_concept
246 // ------------------------------------------------------------------
247 
248 namespace seqan3::detail
249 {
250 
257 template <typename type>
258 struct is_char_adaptation :
259  std::false_type
260 {};
261 
263 template <typename type>
264 constexpr bool is_char_adaptation_v = is_char_adaptation<type>::value;
265 
266 // ------------------------------------------------------------------
267 // seqan3::uint_adaption_concept
268 // ------------------------------------------------------------------
269 
271 template <typename type>
272 struct is_uint_adaptation :
273  std::false_type
274 {};
275 
277 template <typename type>
278 constexpr bool is_uint_adaptation_v = is_uint_adaptation<type>::value;
279 
280 } // namespace seqan3::detail
The rank_type of the semi_alphabet. [type metafunction base template].
Definition: concept_pre.hpp:80
typename underlying_rank< semi_alphabet_type >::type underlying_rank_t
The rank_type of the semi_alphabet. [type metafunction shortcut].
Definition: concept_pre.hpp:88
Contains platform and dependency checks.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
The size of the alphabet. [value metafunction base template].
Definition: concept_pre.hpp:104
Metafunction that indicates to what extent an alphabet can handle pseudoknots. [value metafunction ba...
Definition: concept_pre.hpp:228
Definition: aligned_sequence_concept.hpp:288
The char_type of the alphabet. [type metafunction base template].
Definition: concept_pre.hpp:164
typename underlying_char< alphabet_type >::type underlying_char_t
The char_type of the alphabet. [type metafunction shortcut].
Definition: concept_pre.hpp:172