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

Represents the current set of populations. More...

#include <Current.hpp>

Public Member Functions

 Current ()
 Default constructor. More...
 
 Current (ParamSet *paramSet)
 Standard constructor. More...
 
void reset (ParamSet *paramSet)
 Rebuilds the object. More...
 
virtual ~Current ()
 Destructor. More...
 
 Current (const Current &)
 Copy constructor. More...
 
Currentoperator= (const Current &)
 Assignment operator. More...
 
unsigned int numberOfPopulations () const
 Gets the current number of populations. More...
 
void addPopulation ()
 Adds an empty population to the system. More...
 
unsigned int populationNumberOfLineages (unsigned int populationIndex) const
 Gets the number of lineages contained by a given population. More...
 
Populationpopulation (unsigned int populationIndex)
 Provides access to a given population. More...
 
unsigned int totalNumberOfLineages () const
 Total number of lineages. More...
 
unsigned int efficientNumberOfLineages () const
 Efficient number of lineages. More...
 

Detailed Description

Represents the current set of populations.

Constructor & Destructor Documentation

Current ( )

Default constructor.

Current ( ParamSet paramSet)

Standard constructor.

Parameters
paramSetallows to initiate the correct structure of populations.
~Current ( )
virtual

Destructor.

Current ( const Current source)

Copy constructor.

Member Function Documentation

void addPopulation ( )

Adds an empty population to the system.

unsigned int efficientNumberOfLineages ( ) const

Efficient number of lineages.

This sums the number of covered segments of each lineage.

unsigned int numberOfPopulations ( ) const

Gets the current number of populations.

Current & operator= ( const Current source)

Assignment operator.

Population * population ( unsigned int  populationIndex)

Provides access to a given population.

The returned pointer can be used to modify the object.

unsigned int populationNumberOfLineages ( unsigned int  populationIndex) const

Gets the number of lineages contained by a given population.

void reset ( ParamSet paramSet)

Rebuilds the object.

Parameters
paramSetallows to initiate the correct structure of populations.
unsigned int totalNumberOfLineages ( ) const

Total number of lineages.


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

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