bpp::IFrequenciesSet Class Reference

General interface for distance matrix readers. More...

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

Inheritance diagram for bpp::IFrequenciesSet:

Collaboration diagram for bpp::IFrequenciesSet:

Public Member Functions
	IFrequenciesSet ()
virtual	~IFrequenciesSet ()
virtual FrequenciesSet *	read (const Alphabet *alphabet, const std::string &freqDescription, const SiteContainer *data, bool parseArguments)=0
	Read a frequencies set from a string. More...
virtual const std::map< std::string, std::string > &	getUnparsedArguments () const =0
virtual const std::string	getDataType () const

Detailed Description

General interface for distance matrix readers.

Definition at line 75 of file IoFrequenciesSet.h.

Constructor & Destructor Documentation

IFrequenciesSet()

bpp::IFrequenciesSet::IFrequenciesSet ( )

inline

Definition at line 79 of file IoFrequenciesSet.h.

~IFrequenciesSet()

virtual bpp::IFrequenciesSet::~IFrequenciesSet ( )

inlinevirtual

Definition at line 80 of file IoFrequenciesSet.h.

Member Function Documentation

getDataType()

virtual const std::string bpp::IoFrequenciesSet::getDataType ( ) const

inlinevirtualinherited

Definition at line 69 of file IoFrequenciesSet.h.

getUnparsedArguments()

virtual const std::map<std::string, std::string>& bpp::IFrequenciesSet::getUnparsedArguments ( ) const

pure virtual

Returns

The arguments and their unparsed values from the last call of the read function, if there are any.

Implemented in bpp::BppOFrequenciesSetFormat.

read()

virtual FrequenciesSet* bpp::IFrequenciesSet::read ( const Alphabet *  alphabet, const std::string &  freqDescription, const SiteContainer *  data, bool  parseArguments  )

pure virtual

Read a frequencies set from a string.

Parameters

alphabet	The alpabet to use in the model.
freqDescription	A string describing the frequencies set.
data	A SiteContainer with the data to use to initialize fequency parameters. Can be set to 0.
parseArguments	Attempt to parse function arguments. If not, only store them and use default values instead.

Returns

A new FrequenciesSet object according to options specified.

Exceptions

Exception

if an error occured.

Implemented in bpp::BppOFrequenciesSetFormat.

---

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

• Bpp/Phyl/Io/IoFrequenciesSet.h