bpp-phyl  2.2.0
bpp::SiteSimulator Class Referenceabstract

The SiteSimulator interface. SiteSimulator classes can simulate single sites. More...

#include <Bpp/Phyl/Simulation/SiteSimulator.h>

+ Inheritance diagram for bpp::SiteSimulator:

Public Member Functions

 SiteSimulator ()
 
virtual ~SiteSimulator ()
 
virtual Site * simulateSite () const =0
 
virtual Site * simulateSite (size_t ancestralStateIndex) const =0
 
virtual Site * simulateSite (size_t ancestralStateIndex, double rate) const =0
 
virtual Site * simulateSite (double rate) const =0
 
virtual std::vector< std::string > getSequencesNames () const =0
 
virtual const Alphabet * getAlphabet () const =0
 

Detailed Description

The SiteSimulator interface. SiteSimulator classes can simulate single sites.

See also
SequenceSimulator interface for simulating whole sequence sets.

Definition at line 55 of file SiteSimulator.h.

Constructor & Destructor Documentation

◆ SiteSimulator()

bpp::SiteSimulator::SiteSimulator ( )
inline

Definition at line 58 of file SiteSimulator.h.

◆ ~SiteSimulator()

virtual bpp::SiteSimulator::~SiteSimulator ( )
inlinevirtual

Definition at line 59 of file SiteSimulator.h.

Member Function Documentation

◆ getAlphabet()

virtual const Alphabet* bpp::SiteSimulator::getAlphabet ( ) const
pure virtual

◆ getSequencesNames()

virtual std::vector<std::string> bpp::SiteSimulator::getSequencesNames ( ) const
pure virtual

◆ simulateSite() [1/4]

virtual Site* bpp::SiteSimulator::simulateSite ( ) const
pure virtual

◆ simulateSite() [2/4]

virtual Site* bpp::SiteSimulator::simulateSite ( size_t  ancestralStateIndex) const
pure virtual

◆ simulateSite() [3/4]

virtual Site* bpp::SiteSimulator::simulateSite ( size_t  ancestralStateIndex,
double  rate 
) const
pure virtual

◆ simulateSite() [4/4]

virtual Site* bpp::SiteSimulator::simulateSite ( double  rate) const
pure virtual

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