seqan3::detail::alignment_matrix_column_major_range_base< derived_t >::alignment_column_type Class Reference

Represents a column within an alignment matrix. More...

Inheritance diagram for seqan3::detail::alignment_matrix_column_major_range_base< derived_t >::alignment_column_type:

Classes
class	iterator_type
	The iterator over an alignment-column. More...

Public Member Functions
constexpr size_t	size () const noexcept
	Returns the size the alignment column.
Constructors, destructor and assignment
constexpr	alignment_column_type ()=default
	Defaulted.
constexpr	alignment_column_type (alignment_column_type const &)=default
	Defaulted.
constexpr	alignment_column_type (alignment_column_type &&)=default
	Defaulted.
constexpr alignment_column_type &	operator= (alignment_column_type const &)=default
	Defaulted.
constexpr alignment_column_type &	operator= (alignment_column_type &&)=default
	Defaulted.
	~alignment_column_type ()=default
	Defaulted.
constexpr	alignment_column_type (derived_t &me, view_type ref)
	Constructs from the derived type.
Iterators
This column type is not const-iterable.
constexpr iterator_type	begin () noexcept
	Returns an iterator to the begin of the column.
constexpr auto	begin () const noexcept=delete
	Deleted begin for const-qualified alignment-columns.
constexpr sentinel	end () noexcept
	Returns an iterator to the end of the column.
constexpr sentinel	end () const noexcept=delete
	Deleted end for const-qualified alignment-columns.

Private Types
using	sentinel = std::ranges::sentinel_t< view_type >
	The sentinel type of the underlying view.
using	view_type = typename deferred_type< typename derived_t::column_data_view_type >::type
	A view aliasing the actual stored data column within the underlying matrix.

Private Attributes
derived_t *	me_ptr {}
	Pointer to the derived type.
view_type	ref {}
	The aliased alignment-column.

Detailed Description

template<typename derived_t>
class seqan3::detail::alignment_matrix_column_major_range_base< derived_t >::alignment_column_type

Represents a column within an alignment matrix.

The alignment-column depends on the column_data_view_type of the derived type. This type is used to alias the actual data storage of the underlying matrix implementation such that it does not own the data.

Constructor & Destructor Documentation

alignment_column_type()

template<typename derived_t >

constexpr seqan3::detail::alignment_matrix_column_major_range_base< derived_t >::alignment_column_type::alignment_column_type ( derived_t &  me, view_type  ref  )

inlineconstexpr

Constructs from the derived type.

Parameters

[in]	me	An instance of the derived type.
[in]	ref	The underlying view referencing the current column in the matrix.

This constructor is called by the derived type when invoking the function initialise_column.

---

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

• alignment_matrix_column_major_range_base.hpp