seqan3::detail::combined_score_and_trace_matrix< score_matrix_t, trace_matrix_t >::sentinel Class Reference

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.

Detailed Description

template<std::ranges::input_range score_matrix_t, std::ranges::input_range trace_matrix_t>
requires (std::ranges::input_range<std::ranges::range_reference_t<score_matrix_t>> && std::ranges::input_range<std::ranges::range_reference_t<trace_matrix_t>>)
class seqan3::detail::combined_score_and_trace_matrix< score_matrix_t, trace_matrix_t >::sentinel

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.

Constructor & Destructor Documentation

sentinel()

template<std::ranges::input_range score_matrix_t, std::ranges::input_range trace_matrix_t>

seqan3::detail::combined_score_and_trace_matrix< score_matrix_t, trace_matrix_t >::sentinel::sentinel ( score_matrix_sentinel_type  score_matrix_sentinel )

inlineexplicitnoexcept

Initialises the sentinel from the underlying matrix.

Parameters

[in]

score_matrix_sentinel

The sentinel of the score matrix.

Member Function Documentation

equal()

template<std::ranges::input_range score_matrix_t, std::ranges::input_range trace_matrix_t>

constexpr bool seqan3::detail::combined_score_and_trace_matrix< score_matrix_t, trace_matrix_t >::sentinel::equal ( iterator const &  iter ) const

inlineconstexprprivatenoexcept

Compares the stored score matrix sentinel with the given iterator.

Parameters

[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.

---

The documentation for this class was generated from the following file:

• combined_score_and_trace_matrix.hpp