36#include <seqan3/io/detail/record.hpp>
156 requires std::is_floating_point_v<typename t::bpp_prob>;
173 requires std::is_same_v<typename t::structure_alphabet, dssp9>
179 <
typename t::template structured_seq_alphabet
180 <
typename t::seq_alphabet,
typename t::structure_alphabet>,
181 typename t::seq_alphabet,
typename t::structure_alphabet>,
182 typename t::template structured_seq_alphabet<typename t::seq_alphabet, typename t::structure_alphabet>>;
189 requires std::is_floating_point_v<typename t::energy_type::value_type>;
192 requires std::is_floating_point_v<typename t::react_type>;
237 template <
typename _seq_alphabet>
246 template <
typename _
id_alphabet>
258 template <
typename _bpp_prob,
typename _bpp_partner>
262 template <
typename _bpp_item>
266 template <
typename _bpp_queue>
275 template <
typename _structure_alphabet>
281 template <
typename _seq_alphabet,
typename _structure_alphabet>
285 template <
typename _structured_seq_alphabet>
299 template <
typename _react_type>
308 template <
typename _comment_alphabet>
334 template <
typename _seq_alphabet,
typename _structure_alphabet>
391 static_assert([]()
constexpr
393 for (
field f : selected_field_ids::as_array)
394 if (!field_ids::contains(f))
398 "You selected a field that is not valid for structure files, please refer to the documentation "
399 "of structure_file_input::field_ids for the accepted values.");
401 static_assert([]()
constexpr
406 }(),
"You may not select field::structured_seq and either of field::seq and field::structure "
407 "at the same time.");
415 using seq_type =
typename traits_type::template seq_container<typename traits_type::seq_alphabet>;
417 using id_type =
typename traits_type::template id_container<typename traits_type::id_alphabet>;
419 using bpp_type =
typename traits_type::template bpp_container
420 <
typename traits_type::template bpp_queue
421 <
typename traits_type::template bpp_item
422 <
typename traits_type::bpp_prob,
typename traits_type::bpp_partner>>>;
425 <
typename traits_type::structure_alphabet>;
428 <
typename traits_type::template structured_seq_alphabet
429 <
typename traits_type::seq_alphabet,
typename traits_type::structure_alphabet>>;
433 using react_type =
typename traits_type::template react_container<typename traits_type::react_type>;
436 <
typename traits_type::comment_alphabet>;
464 using iterator = detail::in_file_iterator<structure_file_input>;
507 primary_stream->rdbuf()->pubsetbuf(stream_buffer.data(), stream_buffer.size());
509 std::ios_base::in | std::ios::binary);
511 if (!primary_stream->good())
512 throw file_open_error{
"Could not open file " + filename.
string() +
" for reading."};
515 secondary_stream = detail::make_secondary_istream(*primary_stream, filename);
518 detail::set_format(format, filename);
536 template <input_stream stream_t, structure_file_input_format file_format>
538 requires std::same_as<typename std::remove_reference_t<stream_t>::char_type,
char>
541 file_format
const & SEQAN3_DOXYGEN_ONLY(format_tag),
543 primary_stream{&stream, stream_deleter_noop},
544 format{detail::structure_file_input_format_exposer<file_format>{}}
546 static_assert(list_traits::contains<file_format, valid_formats>,
547 "You selected a format that is not in the valid_formats of this file.");
550 secondary_stream = detail::make_secondary_istream(*primary_stream);
554 template <input_stream stream_t, structure_file_input_format file_format>
556 requires std::same_as<typename std::remove_reference_t<stream_t>::char_type,
char>
559 file_format
const & SEQAN3_DOXYGEN_ONLY(format_tag),
561 primary_stream{
new stream_t{std::move(stream)}, stream_deleter_default},
562 format{detail::structure_file_input_format_exposer<file_format>{}}
564 static_assert(list_traits::contains<file_format, valid_formats>,
565 "You selected a format that is not in the valid_formats of this file.");
568 secondary_stream = detail::make_secondary_istream(*primary_stream);
593 if (!first_record_was_read)
596 first_record_was_read =
true;
676 stream_ptr_t primary_stream{
nullptr, stream_deleter_noop};
678 stream_ptr_t secondary_stream{
nullptr, stream_deleter_noop};
681 bool first_record_was_read{
false};
686 using format_type =
typename detail::variant_from_tags<
valid_formats,
687 detail::structure_file_input_format_exposer>::type;
693 void read_next_record()
696 record_buffer.
clear();
706 assert(!
format.valueless_by_exception());
713 "You may not select field::structured_seq and field::structure at the same time.");
715 "You may not select field::structured_seq and field::seq at the same time.");
716 f.read_structure_record(*secondary_stream,
718 detail::get_or_ignore<field::structured_seq>(record_buffer),
719 detail::get_or_ignore<field::id>(record_buffer),
720 detail::get_or_ignore<field::bpp>(record_buffer),
721 detail::get_or_ignore<field::structured_seq>(record_buffer),
722 detail::get_or_ignore<field::energy>(record_buffer),
723 detail::get_or_ignore<field::react>(record_buffer),
724 detail::get_or_ignore<field::react_err>(record_buffer),
725 detail::get_or_ignore<field::comment>(record_buffer),
726 detail::get_or_ignore<field::offset>(record_buffer));
730 f.read_structure_record(*secondary_stream,
732 detail::get_or_ignore<field::seq>(record_buffer),
733 detail::get_or_ignore<field::id>(record_buffer),
734 detail::get_or_ignore<field::bpp>(record_buffer),
735 detail::get_or_ignore<field::structure>(record_buffer),
736 detail::get_or_ignore<field::energy>(record_buffer),
737 detail::get_or_ignore<field::react>(record_buffer),
738 detail::get_or_ignore<field::react_err>(record_buffer),
739 detail::get_or_ignore<field::comment>(record_buffer),
740 detail::get_or_ignore<field::offset>(record_buffer));
755template <input_stream stream_type,
757 detail::fields_specialisation selected_field_ids>
764template <input_stream stream_type,
Provides seqan3::aa27, container aliases and string literals.
Provides alphabet adaptations for standard char types.
The twenty-seven letter amino acid alphabet..
Definition: aa27.hpp:46
The protein structure alphabet of the characters "HGIEBTSCX"..
Definition: dssp9.hpp:63
The 15 letter RNA alphabet, containing all IUPAC smybols minus the gap..
Definition: rna15.hpp:51
The five letter RNA alphabet of A,C,G,U and the unknown character N..
Definition: rna5.hpp:49
A seqan3::alphabet_tuple_base that joins an aminoacid alphabet with a protein structure alphabet....
Definition: structured_aa.hpp:56
A seqan3::alphabet_tuple_base that joins a nucleotide alphabet with an RNA structure alphabet....
Definition: structured_rna.hpp:57
Provides the dssp format for protein structure.
The <filesystem> header from C++17's standard library.
field
An enumerator for the fields used in file formats.
Definition: record.hpp:63
@ energy
Energy of a folded sequence, represented by one float number.
@ comment
Comment field of arbitrary content, usually a string.
@ structure
Fixed interactions, usually a string of structure alphabet characters.
@ bpp
Base pair probability matrix of interactions, usually a matrix of float numbers.
@ react
Reactivity values of the sequence characters given in a vector of float numbers.
@ react_err
Reactivity error values given in a vector corresponding to seqan3::field::react.
@ offset
Sequence (seqan3::field::seq) relative start position (0-based), unsigned value.
@ structured_seq
Sequence and fixed interactions combined in one range.
@ id
The identifier, usually a string.
@ seq
The "sequence", usually a range of nucleotides or amino acids.
constexpr bool contains
Whether a type occurs in a type list or not.
Definition: traits.hpp:231
Provides the seqan3::detail::in_file_iterator class template.
Resolves to std::ranges::explicitly_convertible_to<type1, type2>().
A concept that indicates whether an alphabet represents RNA structure.
A more refined container concept than seqan3::container.
Refines seqan3::alphabet and adds assignability.
Provides exceptions used in the I/O module.
The main SeqAn3 namespace.
Definition: cigar_operation_table.hpp:2
Provides seqan3::rna15, container aliases and string literals.
Provides seqan3::rna5, container aliases and string literals.
A class template that holds a choice of seqan3::field.
Definition: record.hpp:128
void clear() noexcept(noexcept(std::apply(expander, std::declval< record & >())))
Clears containers that provide .clear() and (re-)initialises all other elements with = {}.
Definition: record.hpp:235
Type that contains multiple types.
Definition: type_list.hpp:29
Provides seqan3::structure_record.
Provides the composite of aminoacid with structure alphabets.
Provides traits for seqan3::type_list.
Adaptations of concepts from the standard library.