LocARNA::MultipleAlignment::AliColumn Class Reference

read only proxy class representing a column of the alignment More...

#include <multiple_alignment.hh>

Classes
class	const_iterator
	const iterator More...

Public Types
using	value_type = char
using	iterator = const_iterator
	iterator More...

Public Member Functions
	AliColumn (const MultipleAlignment &ma, size_type col_index)
	Construct from multiple alignment column. More...
const char &	operator[] (size_type row_index) const
	element access More...
size_type	size () const
	Size / Number of rows. More...
bool	operator== (const AliColumn &ac) const
	Test equality. More...
bool	operator!= (const AliColumn &ac) const
	Test inequality. More...
auto	begin () const
	begin iterator (always const)
auto	end () const
	end iterator (always const)

Detailed Description

read only proxy class representing a column of the alignment

Allow read only access to the symbols in the column by their row index

Member Typedef Documentation

iterator

using LocARNA::MultipleAlignment::AliColumn::iterator = const_iterator

iterator

Note

out of laziness (mostly), do not provide a real non-const iterator; however, the type must exist for use with zip/enumerate

Constructor & Destructor Documentation

AliColumn()

LocARNA::MultipleAlignment::AliColumn::AliColumn ( const MultipleAlignment &  ma, size_type  col_index  )

inline

Construct from multiple alignment column.

Parameters

ma	multiple alignment
col_index	column index

Member Function Documentation

operator!=()

bool LocARNA::MultipleAlignment::AliColumn::operator!= ( const AliColumn &  ac ) const

inline

Test inequality.

Parameters

ac	second alignment column

Returns

whether columns are equal

operator==()

bool LocARNA::MultipleAlignment::AliColumn::operator== ( const AliColumn &  ac ) const

inline

Test equality.

Parameters

ac	second alignment column

Returns

whether columns are equal

operator[]()

const char& LocARNA::MultipleAlignment::AliColumn::operator[] ( size_type  row_index ) const

inline

element access

Parameters

row_index

0-based index of alignment row

Returns

character at row in the represented column

size()

size_type LocARNA::MultipleAlignment::AliColumn::size ( ) const

inline

Size / Number of rows.

Returns

number of rows of the multiple alignment

---

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

• src/LocARNA/multiple_alignment.hh