seqan3::alignment_range< alignment_executor_type >::alignment_range_iterator Class Reference

The iterator of seqan3::detail::alignment_range. More...

#include <seqan3/alignment/pairwise/alignment_range.hpp>

Inheritance diagram for seqan3::alignment_range< alignment_executor_type >::alignment_range_iterator:

Public Types
using	difference_type = typename alignment_range::difference_type
	Type for distances between iterators.
using	iterator_category = std::input_iterator_tag
	Sets iterator category as input iterator.
using	pointer = std::add_pointer_t< value_type >
	Pointer type is pointer of container element type.
using	reference = typename alignment_range::reference
	Use reference type defined by container.
using	value_type = typename alignment_range::value_type
	Value type of container elements.

Public Member Functions
Constructors, destructor and assignment
constexpr	alignment_range_iterator () noexcept=default
	Defaulted.
constexpr	alignment_range_iterator (alignment_range_iterator const &) noexcept=default
	Defaulted.
constexpr	alignment_range_iterator (alignment_range_iterator &&) noexcept=default
	Defaulted.
constexpr alignment_range_iterator &	operator= (alignment_range_iterator const &) noexcept=default
	Defaulted.
constexpr alignment_range_iterator &	operator= (alignment_range_iterator &&) noexcept=default
	Defaulted.
	~alignment_range_iterator ()=default
	Defaulted.
constexpr	alignment_range_iterator (alignment_range &range)
	Construct from alignment stream.
Access operators
reference	operator* () const noexcept
	Access the pointed-to element. More...
pointer	operator-> () const noexcept
	Returns a pointer to the current alignment result.
Increment operators
alignment_range_iterator &	operator++ ()
	Increments the iterator by one.
void	operator++ (int)
	Returns an iterator incremented by one.

Friends
Comparison operators
constexpr friend bool	operator== (alignment_range_iterator const &lhs, std::ranges::default_sentinel_t const &) noexcept
	Checks whether lhs is equal to the sentinel.
constexpr friend bool	operator== (std::ranges::default_sentinel_t const &lhs, alignment_range_iterator const &rhs) noexcept
	Checks whether lhs is equal to rhs.
constexpr friend bool	operator!= (alignment_range_iterator const &lhs, std::ranges::default_sentinel_t const &rhs) noexcept
	Checks whether *this is not equal to the sentinel.
constexpr friend bool	operator!= (std::ranges::default_sentinel_t const &lhs, alignment_range_iterator const &rhs) noexcept
	Checks whether lhs is not equal to rhs.

Detailed Description

template<typename alignment_executor_type>
class seqan3::alignment_range< alignment_executor_type >::alignment_range_iterator

The iterator of seqan3::detail::alignment_range.

Member Function Documentation

operator*()

template<typename alignment_executor_type >

reference seqan3::alignment_range< alignment_executor_type >::alignment_range_iterator::operator* ( ) const

inlinenoexcept

Access the pointed-to element.

Returns

A reference to the current element.

Returns the current alignment result.

---

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

• seqan3/alignment/pairwise/alignment_range.hpp