Stores the alignment results and gives access to score, alignment and the front and end positions.
More...
|
constexpr auto const & | score_matrix () const noexcept |
| Returns the score matrix used to compute the alignment.
|
|
constexpr auto const & | trace_matrix () const noexcept |
| Returns the trace matrix used to compute the alignment.
|
|
|
Functions to access elements of the alignment result type.
|
constexpr sequence1_id_t | sequence1_id () const noexcept |
| Returns the alignment identifier of the first sequence.
|
|
constexpr sequence2_id_t | sequence2_id () const noexcept |
| Returns the alignment identifier of the second sequence.
|
|
constexpr score_t | score () const noexcept |
| Returns the alignment score.
|
|
constexpr auto | sequence1_end_position () const noexcept |
| Returns the end position of the first sequence of the alignment.
|
|
constexpr auto | sequence2_end_position () const noexcept |
| Returns the end position of the second sequence of the alignment.
|
|
constexpr auto | sequence1_begin_position () const noexcept |
| Returns the begin position of the first sequence of the alignment.
|
|
constexpr auto | sequence2_begin_position () const noexcept |
| Returns the begin position of the second sequence of the alignment.
|
|
constexpr alignment_t const & | alignment () const noexcept |
| Returns the actual alignment, i.e. the base pair matching.
|
|
|
|
Local definition of the types contained in the data object.
|
using | sequence1_id_t = decltype(data.sequence1_id) |
| The type for the alignment identifier for the first sequence.
|
|
using | sequence2_id_t = decltype(data.sequence2_id) |
| The type for the alignment identifier for the second sequence.
|
|
using | score_t = decltype(data.score) |
| The type for the resulting score.
|
|
using | end_positions_t = decltype(data.end_positions) |
| The type for the end positions.
|
|
using | begin_positions_t = decltype(data.begin_positions) |
| The type for the begin positions.
|
|
using | alignment_t = decltype(data.alignment) |
| The type for the alignment.
|
|
template<typename alignment_result_value_t>
requires detail::is_type_specialisation_of_v<alignment_result_value_t,
detail::alignment_result_value_type>
class seqan3::alignment_result< alignment_result_value_t >
Stores the alignment results and gives access to score, alignment and the front and end positions.
- Template Parameters
-
alignment_result_value_t | The underlying value type containing the information from the alignment computation. |
This class provides read-only access to the results of a pairwise alignment computation. It always contains an alignment identifier and the resulting score. Optionally – if the user requests – also the begin and end positions within the sequences and the alignment can be calculated. When accessing a field that has not been calculated, an assertion will fail during compilation.
To access the type of the passed alignment result value use the seqan3::detail::alignment_result_value_type_accessor transformation trait. The seqan3::detail::policy_alignment_result_builder is used to set the respective values. This class is befriended with this class to allow access to the private data member.