SeqAn3
input_format_concept.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 
40 #pragma once
41 
42 #include <fstream>
43 #include <set>
44 #include <string>
45 #include <utility>
46 #include <vector>
47 
53 
54 namespace seqan3
55 {
66 template<typename t>
68 concept structure_file_input_format_concept = requires(t & v,
69  std::ifstream & f,
70  structure_file_input_options<rna5, false> & options,
71  rna5_vector & seq,
72  std::string & id,
73  std::vector<std::set<std::pair<double, size_t>>> & bpp,
74  std::vector<wuss51> & structure,
75  std::vector<structured_rna<rna5, wuss51>> & structured_seq,
76  double energy,
77  double react,
78  double react_err,
79  std::string & comment,
80  size_t offset)
81 {
82  t::file_extensions;
83 
84  { v.read(f, options, seq, id, bpp, structure,
85  energy, react, react_err, comment, offset) } -> void;
86 
87  { v.read(f, options, seq, id, bpp, std::ignore,
88  std::ignore, std::ignore, std::ignore, std::ignore, std::ignore) } -> void;
89 
90  { v.read(f, options, structured_seq, id, std::ignore, structured_seq,
91  energy, std::ignore, std::ignore, std::ignore, std::ignore) } -> void;
92 
93  { v.read(f, options, std::ignore, std::ignore, std::ignore, std::ignore,
94  std::ignore, std::ignore, std::ignore, std::ignore, std::ignore) } -> void;
95  // the last is required to be compile time valid, but should always throw at run-time.
96 };
98 
159 
161 } // namespace seqan3
162 
163 namespace seqan3::detail
164 {
165 
171 template<typename t>
172 constexpr bool is_type_list_of_structure_file_input_formats_v = false;
173 
179 template<typename ... ts>
180 constexpr bool is_type_list_of_structure_file_input_formats_v<type_list<ts...>>
181  = (structure_file_input_format_concept<ts> && ...);
182 
188 template<typename t>
189 concept type_list_of_structure_file_input_formats_concept = is_type_list_of_structure_file_input_formats_v<t>;
190 
191 } // namespace seqan3::detail
Provides seqan3::structure_file_input_options.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
Contains seqan3::rna5, container aliases and string literals.
Provides seqan3::type_list and auxiliary metafunctions.
Contains the WUSS format for RNA structure.
Definition: aligned_sequence_concept.hpp:288
meta::list< types... > type_list
Type that contains multiple types, an alias for meta::list.
Definition: type_list.hpp:54
Contains the composition of nucleotide with structure alphabets.