Egglib 2.1.11
C++ library reference manual
Public Member Functions | List of all members
CharMatrix Class Referenceabstract

Interface for classes usable as a square matrix of characters. More...

#include <CharMatrix.hpp>

Inheritance diagram for CharMatrix:
Align DataMatrix

Public Member Functions

virtual unsigned int numberOfSequences () const =0
 Gets number of rows or sequences. More...
 
virtual unsigned int numberOfSites () const =0
 Gets number of columns or sites. More...
 
virtual char character (unsigned int sequence, unsigned int site) const =0
 Gets the character at a given position. More...
 
virtual unsigned int populationLabel (unsigned int row) const =0
 Gets population index. More...
 
virtual double sitePosition (unsigned int column) const =0
 Get site position. More...
 

Detailed Description

Interface for classes usable as a square matrix of characters.

Member Function Documentation

virtual char character ( unsigned int  sequence,
unsigned int  site 
) const
pure virtual

Gets the character at a given position.

The accessor should be "fast" and does not guarantee to perform out-of-bounds checks

Implemented in Align, and DataMatrix.

virtual unsigned int numberOfSequences ( ) const
pure virtual

Gets number of rows or sequences.

Implemented in Align, and DataMatrix.

virtual unsigned int numberOfSites ( ) const
pure virtual

Gets number of columns or sites.

Implemented in Align, and DataMatrix.

virtual unsigned int populationLabel ( unsigned int  row) const
pure virtual

Gets population index.

Implemented in Align, and DataMatrix.

virtual double sitePosition ( unsigned int  column) const
pure virtual

Get site position.

Implemented in Align, and DataMatrix.


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

Hosted by 
Get EggLib at SourceForge.net. Fast, secure and Free Open Source software downloads