bpp-phyl  2.2.0
bpp::BppORateDistributionFormat Class Reference

Rate Distribution I/O in BppO format. More...

#include <Bpp/Phyl/Io/BppORateDistributionFormat.h>

+ Inheritance diagram for bpp::BppORateDistributionFormat:
+ Collaboration diagram for bpp::BppORateDistributionFormat:

Public Member Functions

 BppORateDistributionFormat (bool allowConstant)
 Build a new BppORateDistributionFormat object. More...
 
virtual ~BppORateDistributionFormat ()
 
DiscreteDistribution * read (const std::string &distDescription, bool parseArguments)
 
void write (const DiscreteDistribution &dist, OutputStream &out, std::map< std::string, std::string > &globalAliases, std::vector< std::string > &writtenNames) const
 

Private Attributes

bool allowConstant_
 

Detailed Description

Rate Distribution I/O in BppO format.

Creates a new discrete distribution object according to distribution description syntax (see the Bio++ Progam Suite manual for a detailed description of this syntax).

Rate distributions are normalized and have a mean of 1, so that branch lengths are measured in mean number of substitutions per site.

See also
BppODiscreteDistribtution for a more generic parser.

Definition at line 60 of file BppORateDistributionFormat.h.

Constructor & Destructor Documentation

◆ BppORateDistributionFormat()

bpp::BppORateDistributionFormat::BppORateDistributionFormat ( bool  allowConstant)
inline

Build a new BppORateDistributionFormat object.

Parameters
allowConstantIs contant distribution allowed.

Definition at line 72 of file BppORateDistributionFormat.h.

◆ ~BppORateDistributionFormat()

virtual bpp::BppORateDistributionFormat::~BppORateDistributionFormat ( )
inlinevirtual

Definition at line 77 of file BppORateDistributionFormat.h.

Member Function Documentation

◆ read()

DiscreteDistribution * BppORateDistributionFormat::read ( const std::string &  distDescription,
bool  parseArguments 
)

◆ write()

void BppORateDistributionFormat::write ( const DiscreteDistribution &  dist,
OutputStream &  out,
std::map< std::string, std::string > &  globalAliases,
std::vector< std::string > &  writtenNames 
) const

Member Data Documentation

◆ allowConstant_

bool bpp::BppORateDistributionFormat::allowConstant_
private

Definition at line 64 of file BppORateDistributionFormat.h.


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