LocARNA-1.8.11
Public Member Functions | List of all members
LocARNA::MultipleAlignment::AliColumn Class Reference

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

#include <multiple_alignment.hh>

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...
 

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

Constructor & Destructor Documentation

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

Construct from multiple alignment column.

Parameters
mamultiple alignment
col_indexcolumn index

Member Function Documentation

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

Test inequality.

Parameters
acsecond alignment column
Returns
whether columns are equal
bool LocARNA::MultipleAlignment::AliColumn::operator== ( const AliColumn ac) const
inline

Test equality.

Parameters
acsecond alignment column
Returns
whether columns are equal
const char& LocARNA::MultipleAlignment::AliColumn::operator[] ( size_type  row_index) const
inline

element access

Parameters
row_index0-based index of alignment row
Returns
character at row in the represented column
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: