The alignment. More...
#include <seqan3/alignment/pairwise/alignment_range.hpp>
Public Types | |
using | const_iterator = void |
This range is never const-iterable. The const_iterator is always void. | |
using | difference_type = typename alignment_executor_type::difference_type |
The offset type. | |
using | iterator = iterator_type |
The iterator type. | |
using | reference = typename alignment_executor_type::reference |
The reference type. | |
using | sentinel = std::ranges::default_sentinel_t |
The sentinel type. | |
using | value_type = typename alignment_executor_type::value_type |
The alignment result type. | |
Public Member Functions | |
Constructors, destructor and assignment | |
alignment_range ()=default | |
Defaulted. | |
alignment_range (alignment_range const &)=delete | |
This is a move-only type. | |
alignment_range (alignment_range &&)=default | |
Defaulted. | |
alignment_range & | operator= (alignment_range const &)=delete |
This is a move-only type. | |
alignment_range & | operator= (alignment_range &&)=default |
Defaulted. | |
~alignment_range ()=default | |
Defaulted. | |
alignment_range (alignment_executor_type const &_alignment_executor)=delete | |
Explicit deletion to forbid copy construction of the underlying executor. | |
alignment_range (alignment_executor_type &&_alignment_executor) | |
Constructs a new alignment range by taking ownership over the passed alignment buffer. More... | |
Iterators | |
} | |
constexpr iterator | begin () |
Returns an iterator to the first element of the alignment range. More... | |
const_iterator | begin () const =delete |
const_iterator | cbegin () const =delete |
constexpr sentinel | end () noexcept |
Returns a sentinel signaling the end of the alignment range. More... | |
constexpr sentinel | end () const =delete |
constexpr sentinel | cend () const =delete |
Protected Member Functions | |
constexpr bool | eof () const noexcept |
Returns whether the executor buffer reached is end. | |
void | next () |
Receives the next alignment result from the executor buffer. | |
Friends | |
class | iterator_type |
Related Functions | |
(Note that these are not member functions.) | |
Type deduction guide | |
template<typename alignment_executor_type > | |
alignment_range (alignment_executor_type &&) -> alignment_range< std::remove_reference_t< alignment_executor_type >> | |
Deduces from the passed alignment_executor_type. | |
The alignment.
alignment_executor_type | The buffer type for the alignment stream. |
Provides a stream-like range interface over the alignments instances that are computed in a seqan3::detail::alignment_executor_two_way executor.
|
inlineexplicit |
Constructs a new alignment range by taking ownership over the passed alignment buffer.
_alignment_executor_type | The buffer type. Must be the same type as alignment_executor_type when references and cv-qualifiers are removed. |
[in] | _alignment_executor | The buffer to take ownership from. |
Constructs a new alignment range by taking ownership over the passed alignment buffer.
|
inline |
Returns an iterator to the first element of the alignment range.
Invocation of this function will trigger the computation of the first alignment.
|
inlinenoexcept |
Returns a sentinel signaling the end of the alignment range.
The alignment range is an input range and the end is reached when the internal buffer over the alignment results has signaled end-of-stream.