alignment_result.hpp File Reference

Provides seqan3::alignment_result. More...

#include <optional>
#include <seqan3/core/configuration/configuration.hpp>
#include <seqan3/core/debug_stream/debug_stream_type.hpp>
#include <seqan3/core/detail/template_inspection.hpp>

Include dependency graph for alignment_result.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	seqan3::alignment_result< alignment_result_value_t >
	Stores the alignment results and gives access to score, alignment and the front and end positions. More...
struct	seqan3::detail::alignment_result_value_type< sequence1_id_t, sequence2_id_t, score_t, end_positions_t, begin_positions_t, alignment_t, score_debug_matrix_t, trace_debug_matrix_t >
	A struct that contains the actual alignment result data. More...
struct	seqan3::detail::alignment_result_value_type_accessor< alignment_result< result_value_t > >
	Transformation trait to access the hidden result value type of the seqan3::alignment_result class. More...

Namespaces
namespace	seqan3
	The main SeqAn3 namespace.
namespace	seqan3::detail
	The internal SeqAn3 namespace.

Functions
Type deduction guides
	seqan3::detail::alignment_result_value_type () -> alignment_result_value_type< std::nullopt_t *, std::nullopt_t *, std::nullopt_t * >
	Type deduction for an empty object. It will always fail the compilation, if any field is accessed.
template<typename sequence1_id_t , typename sequence2_id_t , typename score_t >
	seqan3::detail::alignment_result_value_type (sequence1_id_t, sequence2_id_t, score_t) -> alignment_result_value_type< sequence1_id_t, sequence2_id_t, score_t >
	Type deduction for id and score only.
template<typename sequence1_id_t , typename sequence2_id_t , typename score_t , typename end_positions_t >
	seqan3::detail::alignment_result_value_type (sequence1_id_t, sequence2_id_t, score_t, end_positions_t) -> alignment_result_value_type< sequence1_id_t, sequence2_id_t, score_t, end_positions_t >
	Type deduction for id, score and end positions.
template<typename sequence1_id_t , typename sequence2_id_t , typename score_t , typename end_positions_t , typename begin_positions_t >
	seqan3::detail::alignment_result_value_type (sequence1_id_t, sequence2_id_t, score_t, end_positions_t, begin_positions_t) -> alignment_result_value_type< sequence1_id_t, sequence2_id_t, score_t, end_positions_t, begin_positions_t >
	Type deduction for id, score, end positions and begin positions.
template<typename sequence1_id_t , typename sequence2_id_t , typename score_t , typename end_positions_t , typename begin_positions_t , typename alignment_t >
	seqan3::detail::alignment_result_value_type (sequence1_id_t, sequence2_id_t, score_t, end_positions_t, begin_positions_t, alignment_t) -> alignment_result_value_type< sequence1_id_t, sequence2_id_t, score_t, end_positions_t, begin_positions_t, alignment_t >
	Type deduction for id, score, end positions, begin positions and alignment.

Detailed Description

Provides seqan3::alignment_result.

Author

Jörg Winkler <j.winkler AT fu-berlin.de>

Rene Rahn <rene.rahn AT fu-berlin.de>