Sets the result of the alignment computation. More...
#include <seqan3/alignment/configuration/align_config_result.hpp>
Public Types | |
using | score_type = score_t |
The score type of the alignment result. | |
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | result ()=default |
Defaulted. | |
constexpr | result (result const &)=default |
Defaulted. | |
constexpr result & | operator= (result const &)=default |
Defaulted. | |
constexpr | result (result &&)=default |
Defaulted. | |
constexpr result & | operator= (result &&)=default |
Defaulted. | |
~result ()=default | |
Defaulted. | |
constexpr | result (alignment_result_tag_t result_tag) noexcept |
Construction from the result feature you want to compute (e.g. seqan3::with_score). More... | |
constexpr | result (alignment_result_tag_t result_tag, detail::score_type< score_t > score_type_tag) noexcept |
Construction from the result feature you want to compute (e.g. seqan3::with_score). More... | |
Related Functions | |
(Note that these are not member functions.) | |
template<arithmetic score_t> | |
constexpr detail::score_type< score_t > | using_score_type {} |
Helper variable used to configure the score type for the alignment algorithm. More... | |
constexpr detail::with_alignment_type | with_alignment {} |
Helper Variable used to select trace computation. | |
constexpr detail::with_back_coordinate_type | with_back_coordinate {} |
Helper variable used to select end-position computation. | |
constexpr detail::with_front_coordinate_type | with_front_coordinate {} |
Helper variable used to select begin position computation. | |
constexpr detail::with_score_type | with_score {} |
Helper variable used to select score-only computation. | |
Type deduction guides | |
template<typename alignment_result_tag_t > | |
result (alignment_result_tag_t) -> result< alignment_result_tag_t > | |
Deduces the alignment result from the given constructor argument. | |
template<typename alignment_result_tag_t , arithmetic score_t> | |
result (alignment_result_tag_t, detail::score_type< score_t >) -> result< alignment_result_tag_t, score_t > | |
Deduces the alignment result from the given constructor arguments. | |
Sets the result of the alignment computation.
alignment_result_tag_t | The type used to specify which feature should be computed during the pairwise alignment. Defaults to seqan3::detail::with_score_type. |
The output of the pairwise alignment can be configured using this result configuration element. Depending on the settings, the most efficient implementation is chosen to compute the result. Currently four different modes can be configured (first constructor parameter):
These settings will directly affect the contents of the seqan3::alignment_result object which is returned by the alignment algorithm. For example, if you chose the alignment feature, your result object will contain the score, end point, begin point and the alignment.
In addition, you can specify the score type with the second constructor argument (see example).
By default, the alignment algorithm will only compute the score with score type int32_t
.
|
inlineconstexprnoexcept |
Construction from the result feature you want to compute (e.g. seqan3::with_score).
[in] | result_tag | The feature you want the alignment algorithm to compute (e.g. seqan3::with_score). |
|
inlineconstexprnoexcept |
Construction from the result feature you want to compute (e.g. seqan3::with_score).
[in] | result_tag | The feature you want the alignment algorithm to compute (e.g. seqan3::with_score). |
[in] | score_type_tag | The score type to use (e.g. seqan3::using_score_type<int>). |
|
related |
Helper variable used to configure the score type for the alignment algorithm.
t | The type to use for the computed alignment score; must model seqan3::arithmetic. |