SeqAn3
seqan3::alignment_range< range_buffer_t > Class Template Reference

The alignment. More...

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

Public Types

using difference_type = typename range_buffer_t::difference_type
 The offset type.
 
using iterator = iterator_type
 The iterator type.
 
using reference = typename range_buffer_t::reference
 The reference type.
 
using sentinel = std::ranges::default_sentinel
 The sentinel type.
 
using value_type = typename range_buffer_t::value_type
 The alignment result type.
 

Public Member Functions

Constructors, destructor and assignment
 alignment_range ()=delete
 
 alignment_range (alignment_range const &)=default
 
 alignment_range (alignment_range &&)=default
 
alignment_rangeoperator= (alignment_range const &)=default
 
alignment_rangeoperator= (alignment_range &&)=default
 
 ~alignment_range ()=default
 
 alignment_range (range_buffer_t &_range_buffer)
 
template<typename resource_t , typename selector_t >
 alignment_range (resource_t _range_buffer_resource, selector_t _selector)
 
Iterators

}

iterator begin ()
 
sentinel end () noexcept
 

Protected Member Functions

auto & cached () noexcept
 Returns the cached result.
 
auto const & cached () const noexcept
 Returns the cached result. More...
 
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
 

Detailed Description

template<typename range_buffer_t>
class seqan3::alignment_range< range_buffer_t >

The alignment.

Template Parameters
range_buffer_tThe 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.

Member Function Documentation

◆ cached()

template<typename range_buffer_t >
auto const& seqan3::alignment_range< range_buffer_t >::cached ( ) const
inlineprotectednoexcept

Returns the cached result.


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