Represents the begin/end of the pairwise alignment in the respective sequences. More...
#include <seqan3/alignment/matrix/alignment_coordinate.hpp>
Public Types | |
Member types | |
using | difference_type = std::make_signed_t< size_t > |
Defines the difference type to model the std::weakly_incrementable concept. | |
Public Member Functions | |
Constructors, destructor and assignment | |
constexpr | alignment_coordinate ()=default |
Defaulted. | |
constexpr | alignment_coordinate (alignment_coordinate const &)=default |
Defaulted. | |
constexpr | alignment_coordinate (alignment_coordinate &&)=default |
Defaulted. | |
constexpr alignment_coordinate & | operator= (alignment_coordinate const &)=default |
Defaulted. | |
constexpr alignment_coordinate & | operator= (alignment_coordinate &&)=default |
Defaulted. | |
~alignment_coordinate ()=default | |
Defaulted. | |
constexpr | alignment_coordinate (base_t const &base) |
Constructs from the seqan3::detail::advanceable_alignment_coordinate base class. | |
constexpr | alignment_coordinate (base_t &&base) |
Constructs from the seqan3::detail::advanceable_alignment_coordinate base class. | |
Member functions | |
Advances or decrements the respective column or row coordinate depending on the set policy. These member functions are not available if the non-type template parameter | |
constexpr advanceable_alignment_coordinate & | operator++ () noexcept |
Increments the coordinate depending on the set policy by one. More... | |
constexpr advanceable_alignment_coordinate | operator++ (int) noexcept |
Post-increments the coordinate depending on the set policy by one. More... | |
constexpr advanceable_alignment_coordinate & | operator-- () noexcept |
Decrements the coordinate depending on the set policy by one. More... | |
constexpr advanceable_alignment_coordinate | operator-- (int) noexcept |
Post-decrements the coordinate depending on the set policy by one. More... | |
constexpr advanceable_alignment_coordinate & | operator+= (difference_type const offset) noexcept |
Returns the coordinate which is advanced depending on the set policy by offset . More... | |
constexpr advanceable_alignment_coordinate & | operator-= (difference_type const offset) noexcept |
Returns the coordinate which is advanced depending on the set policy by -offset . More... | |
constexpr advanceable_alignment_coordinate | operator+ (difference_type const offset) const noexcept |
Returns a new coordinate which is advanced depending on the set policy by offset . More... | |
constexpr advanceable_alignment_coordinate | operator- (difference_type const offset) const noexcept |
Returns a new coordinate which is advanced depending on the set policy by -offset . More... | |
constexpr difference_type | operator- (advanceable_alignment_coordinate const &other) const noexcept |
Returns the difference of this and another coordinate depending on the set policy. More... | |
Public Attributes | |
size_t | first |
The begin/end position of the alignment in the first sequence. | |
size_t | second |
The begin/end position of the alignment in the second sequence. | |
Private Types | |
using | base_t = detail::advanceable_alignment_coordinate< detail::advanceable_alignment_coordinate_state::none > |
The type of the base class. | |
Private Member Functions | |
constexpr | operator detail::matrix_coordinate () const |
Implicit conversion to seqan3::detail::matrix_coordinate. | |
Represents the begin/end of the pairwise alignment in the respective sequences.
This class only gives access to the respective positions of the sequences and is meant for the user interface. The additional complexity of an advanceable coordinate using the seqan3::detail::advanceable_alignment_coordinate is only necessary for the implementation of the pairwise alignment algorithm. Within in the algorithm the coordinate is used in combination with a seqan3::views::iota to keep track of the current position within the alignment matrix. For the user, however, this interface adds no benefit as they are only interested in the front/back coordinates for the respective alignment.
|
inlineconstexprnoexceptinherited |
Returns a new coordinate which is advanced depending on the set policy by offset
.
offset | The value to add to the coordinate. |
|
inlineconstexprnoexceptinherited |
Increments the coordinate depending on the set policy by one.
*this
|
inlineconstexprnoexceptinherited |
Post-increments the coordinate depending on the set policy by one.
|
inlineconstexprnoexceptinherited |
Returns the coordinate which is advanced depending on the set policy by offset
.
offset | The value to add to the coordinate. |
*this
|
inlineconstexprnoexceptinherited |
Returns the difference of this and another coordinate depending on the set policy.
other | The other coordinate. |
|
inlineconstexprnoexceptinherited |
Returns a new coordinate which is advanced depending on the set policy by -offset
.
offset | The value to subtract from the coordinate. |
|
inlineconstexprnoexceptinherited |
Decrements the coordinate depending on the set policy by one.
*this
|
inlineconstexprnoexceptinherited |
Post-decrements the coordinate depending on the set policy by one.
|
inlineconstexprnoexceptinherited |
Returns the coordinate which is advanced depending on the set policy by -offset
.
offset | The value to subtract from the coordinate. |
*this