The record type of seqan3::structure_file_input. More...

#include <seqan3/io/structure_file/record.hpp>

Inheritance diagram for seqan3::structure_record< field_types, field_ids >:

Public Member Functions
decltype(auto)	base_pair_probability_matrix () &
	Base pair probability matrix of interactions, usually a matrix of float numbers. More...

decltype(auto)	base_pair_probability_matrix () &&
	Base pair probability matrix of interactions, usually a matrix of float numbers.

decltype(auto)	base_pair_probability_matrix () const &
	Base pair probability matrix of interactions, usually a matrix of float numbers. More...

decltype(auto)	base_pair_probability_matrix () const &&
	Base pair probability matrix of interactions, usually a matrix of float numbers. More...

decltype(auto)	energy () &
	Energy of a folded sequence, represented by one float number. More...

decltype(auto)	energy () &&
	Energy of a folded sequence, represented by one float number.

decltype(auto)	energy () const &
	Energy of a folded sequence, represented by one float number. More...

decltype(auto)	energy () const &&
	Energy of a folded sequence, represented by one float number. More...

decltype(auto)	id () &
	The identifier, usually a string. More...

decltype(auto)	id () &&
	The identifier, usually a string.

decltype(auto)	id () const &
	The identifier, usually a string. More...

decltype(auto)	id () const &&
	The identifier, usually a string. More...

decltype(auto)	sequence () &
	The "sequence", usually a range of nucleotides or amino acids. More...

decltype(auto)	sequence () &&
	The "sequence", usually a range of nucleotides or amino acids.

decltype(auto)	sequence () const &
	The "sequence", usually a range of nucleotides or amino acids. More...

decltype(auto)	sequence () const &&
	The "sequence", usually a range of nucleotides or amino acids. More...

decltype(auto)	sequence_structure () &
	Fixed interactions, usually a string of structure alphabet characters. More...

decltype(auto)	sequence_structure () &&
	Fixed interactions, usually a string of structure alphabet characters.

decltype(auto)	sequence_structure () const &
	Fixed interactions, usually a string of structure alphabet characters. More...

decltype(auto)	sequence_structure () const &&
	Fixed interactions, usually a string of structure alphabet characters. More...

Constructors, destructor and assignment
	structure_record ()=default
	Defaulted.

	structure_record (structure_record const &)=default
	Defaulted.

structure_record &	operator= (structure_record const &)=default
	Defaulted.

	structure_record (structure_record &&)=default
	Defaulted.

structure_record &	operator= (structure_record &&)=default
	Defaulted.

	~structure_record ()=default
	Defaulted.

Public Member Functions inherited from seqan3::record< field_types, field_ids >
void	clear () noexcept(noexcept(std::apply(expander, std::declval< record & >())))
	Clears containers that provide `.clear()` and (re-)initialises all other elements with `= {}`.

	record ()=default
	Defaulted.

	record (record const &)=default
	Defaulted.

record &	operator= (record const &)=default
	Defaulted.

	record (record &&)=default
	Defaulted.

record &	operator= (record &&)=default
	Defaulted.

	~record ()=default
	Defaulted.

Additional Inherited Members
Public Types inherited from seqan3::record< field_types, field_ids >
using	base_type = detail::transfer_template_args_onto_t< field_types, std::tuple >
	A specialisation of std::tuple.

Related Functions inherited from seqan3::record< field_types, field_ids >
template<field f, typename field_types , typename field_ids >
auto &	get (record< field_types, field_ids > &r)
	Free function get() for seqan3::record based on seqan3::field.

template<field f, typename field_types , typename field_ids >
auto const &	get (record< field_types, field_ids > const &r)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<field f, typename field_types , typename field_ids >
auto &&	get (record< field_types, field_ids > &&r)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<field f, typename field_types , typename field_ids >
auto const &&	get (record< field_types, field_ids > const &&r)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Related Functions inherited from tuple_like
size_t	tuple_size_v
	A unary type trait that holds the number of elements in the tuple. More...

	tuple_elment_t
	A transformation trait that holds the type of elements in the tuple. More...

auto &&	get (type &&val)
	Return the i-th element of the tuple. More...

Detailed Description

template<typename field_types, typename field_ids>
class seqan3::structure_record< field_types, field_ids >

The record type of seqan3::structure_file_input.

Template Parameters

field_types	The types of the fields in this record as a seqan3::type_list.
field_ids	A seqan3::fields type with seqan3::field IDs corresponding to field_types.