seqan3::detail::two_dimensional_matrix_iterator< iter_t > Interface Template Reference

A concept for iterators over a two dimensional matrix, e.g. seqan3::detail::two_dimensional_matrix. More...

#include <seqan3/alignment/matrix/detail/two_dimensional_matrix_iterator_concept.hpp>

Inheritance diagram for seqan3::detail::two_dimensional_matrix_iterator< iter_t >:

Related Symbols
(Note that these are not member symbols.)
Requirements for seqan3::detail::two_dimensional_matrix_iterator
You can expect these functions on all types that model seqan3::detail::two_dimensional_matrix_iterator.
iterator &	operator+= (seqan3::detail::matrix_offset offset) noexcept
	Advances the iterator by offset in the respective dimension.
constexpr iterator	operator+ (seqan3::detail::matrix_offset offset) const noexcept
	Returns an iterator advanced by offset in the respective dimension.
constexpr friend iterator	operator+ (seqan3::detail::matrix_offset offset, iterator const iter) noexcept
	Returns an iterator advanced by offset in the respective dimension.
constexpr iterator &	operator-= (seqan3::detail::matrix_offset offset) noexcept
	Advances the iterator by offset in the respective dimension.
constexpr iterator	operator- (seqan3::detail::matrix_offset offset) const noexcept
	Returns an iterator advanced by offset in the respective dimension.
constexpr seqan3::detail::matrix_coordinate	coordinate () const noexcept
	Returns the current position of the iterator as a two-dimensional matrix coordinate.

Detailed Description

template<typename iter_t>
interface seqan3::detail::two_dimensional_matrix_iterator< iter_t >

A concept for iterators over a two dimensional matrix, e.g. seqan3::detail::two_dimensional_matrix.

This concept describes the requirements an iterator must fulfil in order to be used inside various parts of the alignment algorithm, e.g. to compute the traceback path after filling the alignment matrix.

Friends And Related Symbol Documentation

coordinate()

template<typename iter_t >

constexpr seqan3::detail::matrix_coordinate coordinate ( ) const

related

Returns the current position of the iterator as a two-dimensional matrix coordinate.

Attention

This is a concept requirement, not an actual function (however types modelling this concept will provide an implementation).

Implemented in seqan3::detail::two_dimensional_matrix< value_t, allocator_t, order >::basic_iterator< const_range >, seqan3::detail::two_dimensional_matrix_iterator_base< derived_t, order >, and seqan3::detail::two_dimensional_matrix_iterator_base< basic_iterator< const_range >, order >.

operator+() [1/2]

template<typename iter_t >

constexpr iterator operator+ ( seqan3::detail::matrix_offset  offset ) const

related

Returns an iterator advanced by offset in the respective dimension.

Parameters

[in]

offset

The matrix offset in a particular dimension.

Attention

This is a concept requirement, not an actual function (however types modelling this concept will provide an implementation).

operator+() [2/2]

template<typename iter_t >

constexpr friend iterator operator+ ( seqan3::detail::matrix_offset  offset, iterator const  iter  )

related

Returns an iterator advanced by offset in the respective dimension.

Template Parameters

iterator

The two dimensional iterator type.

Parameters

[in]	offset	The matrix offset in a particular dimension.
[in]	iter	The iterator to advance by the offset.

Attention

This is a concept requirement, not an actual function (however types modelling this concept will provide an implementation).

operator+=()

template<typename iter_t >

iterator & operator+= ( seqan3::detail::matrix_offset  offset )

related

Advances the iterator by offset in the respective dimension.

Parameters

[in]

offset

The matrix offset in a particular dimension.

Attention

This is a concept requirement, not an actual function (however types modelling this concept will provide an implementation).

operator-()

template<typename iter_t >

constexpr iterator operator- ( seqan3::detail::matrix_offset  offset ) const

related

Returns an iterator advanced by offset in the respective dimension.

Parameters

[in]

offset

The matrix offset in a particular dimension.

Attention

This is a concept requirement, not an actual function (however types modelling this concept will provide an implementation).

operator-=()

template<typename iter_t >

constexpr iterator & operator-= ( seqan3::detail::matrix_offset  offset )

related

Advances the iterator by offset in the respective dimension.

Parameters

[in]

offset

The matrix offset in a particular dimension.

Attention

This is a concept requirement, not an actual function (however types modelling this concept will provide an implementation).

---

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

• two_dimensional_matrix_iterator_concept.hpp