Stores the alignment results and gives access to score, alignment and the front and back coordinates. More...
#include <seqan3/alignment/pairwise/alignment_result.hpp>
Public Member Functions | |
Constructors, destructor and assignment | |
alignment_result (alignment_result_traits value) | |
Constructs a seqan3::alignment_result from an alignment_result_traits object. More... | |
alignment_result ()=default | |
Defaulted. | |
alignment_result (alignment_result const &)=default | |
Defaulted. | |
alignment_result (alignment_result &&)=default | |
Defaulted. | |
alignment_result & | operator= (alignment_result const &)=default |
Defaulted. | |
alignment_result & | operator= (alignment_result &&)=default |
Defaulted. | |
~alignment_result ()=default | |
Access functions | |
Functions to access elements of the alignment result type. | |
constexpr id_t | id () const noexcept |
Returns the alignment identifier. More... | |
constexpr score_t | score () const noexcept |
Returns the alignment score. More... | |
constexpr const back_coord_t & | back_coordinate () const noexcept |
Returns the back coordinate of the alignment. More... | |
constexpr const front_coord_t & | front_coordinate () const noexcept |
Returns the front coordinate of the alignment. More... | |
constexpr const alignment_t & | alignment () const noexcept |
Returns the actual alignment, i.e. the base pair matching. More... | |
Stores the alignment results and gives access to score, alignment and the front and back coordinates.
alignment_result_traits | The type of the traits object. |
Objects of this class are the result of an 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.
|
inline |
Constructs a seqan3::alignment_result from an alignment_result_traits
object.
[in] | value | The alignment results. |
|
default |
Defaulted
|
inlineconstexprnoexcept |
Returns the actual alignment, i.e. the base pair matching.
|
inlineconstexprnoexcept |
Returns the back coordinate of the alignment.
|
inlineconstexprnoexcept |
Returns the front coordinate of the alignment.
Guaranteed to be smaller than or equal to back_coordinate()
.
|
inlineconstexprnoexcept |
Returns the alignment identifier.
|
inlineconstexprnoexcept |
Returns the alignment score.