SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
|
The sentinel type for the seqan3::detail::combined_score_and_trace_matrix. More...
#include <seqan3/alignment/matrix/detail/combined_score_and_trace_matrix.hpp>
Public Member Functions | |
Constructor, assignment and destructor | |
sentinel ()=default | |
Defaulted. | |
sentinel (sentinel const &)=default | |
Defaulted. | |
sentinel (sentinel &&)=default | |
Defaulted. | |
sentinel & | operator= (sentinel const &)=default |
Defaulted. | |
sentinel & | operator= (sentinel &&)=default |
Defaulted. | |
~sentinel ()=default | |
Defaulted. | |
sentinel (score_matrix_sentinel_type score_matrix_sentinel) noexcept | |
Initialises the sentinel from the underlying matrix. | |
Private Types | |
using | score_matrix_sentinel_type = std::ranges::sentinel_t< score_matrix_t > |
The sentinel type of the underlying score matrix. | |
Private Member Functions | |
constexpr bool | equal (iterator const &iter) const noexcept |
Compares the stored score matrix sentinel with the given iterator. | |
Private Attributes | |
score_matrix_sentinel_type | score_matrix_sentinel {} |
The sentinel of the score matrix. | |
Friends | |
Comparison operators | |
bool | operator== (iterator const &lhs, sentinel const &rhs) noexcept |
Checks if the iterator reached the end of the matrix. | |
bool | operator== (sentinel const &lhs, iterator const &rhs) noexcept |
Checks if the iterator reached the end of the matrix. | |
bool | operator!= (iterator const &lhs, sentinel const &rhs) noexcept |
Checks if the iterator did not reach the end of the matrix. | |
bool | operator!= (sentinel const &lhs, iterator const &rhs) noexcept |
Checks if the iterator did not reach the end of the matrix. | |
The sentinel type for the seqan3::detail::combined_score_and_trace_matrix.
The sentinel only compares against the end of the score matrix and not the trace matrix, since the invariant of the matrix requires that both submatrices have the same number of columns.
|
inlineexplicitnoexcept |
Initialises the sentinel from the underlying matrix.
[in] | score_matrix_sentinel | The sentinel of the score matrix. |
|
inlineconstexprprivatenoexcept |
Compares the stored score matrix sentinel with the given iterator.
[in] | iter | The iterator to compare with. |
The additional member function is used to access the private member of the seqan3::detail::combined_score_and_trace_matrix::iterator from the sentinel.