Frequencies in words computed from the frequencies on letters. The parameters are the parameters of the Frequencies on letters. The WordFrequencySet owns the std::shared_ptr<FrequencySet> it is built on. Interface class. More...

#include <Bpp/Phyl/Model/FrequencySet/WordFrequencySet.h>

Inheritance diagram for bpp::WordFrequencySetInterface:

Collaboration diagram for bpp::WordFrequencySetInterface:

Public Member Functions
WordFrequencySetInterface *	clone () const override=0

virtual std::shared_ptr< const CoreWordAlphabet >	getWordAlphabet () const =0

virtual const FrequencySetInterface &	frequencySetForLetter (size_t i) const =0
	Returns the n-th FrequencySet. More...

virtual size_t	getLength () const =0
	Returns the length of the words. More...

virtual std::shared_ptr< const Alphabet >	getAlphabet () const =0

virtual const Alphabet &	alphabet () const =0

virtual const StateMapInterface &	stateMap () const =0

virtual std::shared_ptr< const StateMapInterface >	getStateMap () const =0

virtual const Vdouble &	getFrequencies () const =0

virtual const std::map< int, double >	getAlphabetStatesFrequencies () const =0

virtual void	setFrequencies (const std::vector< double > &frequencies)=0
	Set the parameters in order to match a given set of frequencies. More...

virtual void	setFrequenciesFromAlphabetStatesFrequencies (const std::map< int, double > &frequencies)=0
	Set the Frequencies from the one of the map which keys match with a letter of the Alphabet. The frequencies are normalized so that the matching values sum 1. More...

virtual std::string	getName () const =0

virtual size_t	getNumberOfFrequencies () const =0

virtual size_t	getNumberOfIndependentParameters () const=0

virtual void	aliasParameters (const std::string &p1, const std::string &p2)=0

virtual void	aliasParameters (std::map< std::string, std::string > &unparsedParams, bool verbose)=0

virtual void	unaliasParameters (const std::string &p1, const std::string &p2)=0

virtual const ParameterList &	getIndependentParameters () const=0

virtual std::vector< std::string >	getAlias (const std::string &name) const=0

virtual std::map< std::string, std::string >	getAliases () const=0

virtual bool	hasParameter (const std::string &name) const=0

virtual const ParameterList &	getParameters () const=0

virtual const Parameter &	parameter (const std::string &name) const=0

virtual double	getParameterValue (const std::string &name) const=0

virtual void	setAllParametersValues (const ParameterList &parameters)=0

virtual void	setParameterValue (const std::string &name, double value)=0

virtual void	setParametersValues (const ParameterList &parameters)=0

virtual bool	matchParametersValues (const ParameterList &parameters)=0

virtual void	removeConstraint (const std::string &name)=0

virtual void	setConstraint (const std::string &name, std::shared_ptr< ConstraintInterface > constraint)=0

virtual size_t	getNumberOfParameters () const=0

virtual void	setNamespace (const std::string &prefix)=0

virtual std::string	getNamespace () const=0

virtual std::string	getParameterNameWithoutNamespace (const std::string &name) const=0

Static Public Attributes
static std::shared_ptr< IntervalConstraint >	FREQUENCE_CONSTRAINT_SMALL

static std::shared_ptr< IntervalConstraint >	FREQUENCE_CONSTRAINT_MILLI

static std::shared_ptr< IntervalConstraint >	FREQUENCE_CONSTRAINT_CENTI

Protected Member Functions
virtual size_t	getSizeFromVector (const std::vector< std::unique_ptr< FrequencySetInterface >> &freqVector)=0

virtual ParameterList &	getParameters_ ()=0

Detailed Description

Frequencies in words computed from the frequencies on letters. The parameters are the parameters of the Frequencies on letters. The WordFrequencySet owns the std::shared_ptr<FrequencySet> it is built on. Interface class.

Author: Laurent Guéguen

Definition at line 28 of file WordFrequencySet.h.

Member Function Documentation

◆ alphabet()

virtual const Alphabet& bpp::FrequencySetInterface::alphabet ( ) const

pure virtualinherited

Returns: The alphabet associated to this set.

Implemented in bpp::AbstractFrequencySet.

◆ clone()

WordFrequencySetInterface* bpp::WordFrequencySetInterface::clone ( ) const

overridepure virtual

Implements bpp::FrequencySetInterface.

Implemented in bpp::AbstractWordFrequencySet, bpp::WordFromUniqueFrequencySet, bpp::WordFromIndependentFrequencySet, bpp::CodonFromUniqueFrequencySet, and bpp::CodonFromIndependentFrequencySet.

◆ frequencySetForLetter()

virtual const FrequencySetInterface& bpp::WordFrequencySetInterface::frequencySetForLetter ( size_t i ) const

pure virtual

Returns the n-th FrequencySet.

Implemented in bpp::WordFromUniqueFrequencySet, and bpp::WordFromIndependentFrequencySet.

Referenced by bpp::AbstractCodonPhaseFrequenciesSubstitutionModel::getCodonsMulRate().

◆ getAlphabet()

virtual std::shared_ptr<const Alphabet> bpp::FrequencySetInterface::getAlphabet ( ) const

pure virtualinherited

Returns: The alphabet associated to this set.

Implemented in bpp::AbstractFrequencySet.

Referenced by bpp::UserCodonFrequencySet::getCodonAlphabet(), bpp::FixedNucleotideFrequencySet::getNucleicAlphabet(), bpp::UserNucleotideFrequencySet::getNucleicAlphabet(), bpp::FullProteinFrequencySet::getProteicAlphabet(), bpp::FixedProteinFrequencySet::getProteicAlphabet(), and bpp::UserProteinFrequencySet::getProteicAlphabet().

◆ getAlphabetStatesFrequencies()

virtual const std::map<int, double> bpp::FrequencySetInterface::getAlphabetStatesFrequencies ( ) const

pure virtualinherited

Returns: The frequencies of each alphabet states according to this model.

Implemented in bpp::AbstractFrequencySet.

◆ getFrequencies()

virtual const Vdouble& bpp::FrequencySetInterface::getFrequencies ( ) const

pure virtualinherited

Returns: The frequencies values of the set.

Implemented in bpp::AbstractFrequencySet.

Referenced by bpp::CodonDistanceFrequenciesSubstitutionModel::fireParameterChanged(), bpp::CodonDistancePhaseFrequenciesSubstitutionModel::fireParameterChanged(), bpp::AbstractCodonPhaseFrequenciesSubstitutionModel::getCodonsMulRate(), bpp::NonHomogeneousSubstitutionProcess::getRootFrequencies(), bpp::CodonDistanceFrequenciesSubstitutionModel::setFreq(), bpp::CodonDistancePhaseFrequenciesSubstitutionModel::setFreq(), bpp::DFPDistanceFrequenciesSubstitutionModel::setFreq(), and bpp::BppOFrequencySetFormat::writeFrequencySet().

◆ getLength()

virtual size_t bpp::WordFrequencySetInterface::getLength ( ) const

pure virtual

Returns the length of the words.

Implemented in bpp::WordFromUniqueFrequencySet, bpp::WordFromIndependentFrequencySet, and bpp::AbstractWordFrequencySet.

◆ getName()

virtual std::string bpp::FrequencySetInterface::getName ( ) const

pure virtualinherited

Implemented in bpp::AbstractFrequencySet.

Referenced by bpp::BppOFrequencySetFormat::writeFrequencySet().

◆ getNumberOfFrequencies()

virtual size_t bpp::FrequencySetInterface::getNumberOfFrequencies ( ) const

pure virtualinherited

Returns: The number of frequencies in the set. This is equivalent to getStateMap().getNumberOfModelStates().

Implemented in bpp::AbstractFrequencySet.

◆ getSizeFromVector()

virtual size_t bpp::WordFrequencySetInterface::getSizeFromVector ( const std::vector< std::unique_ptr< FrequencySetInterface >> & freqVector )

protectedpure virtual

Implemented in bpp::AbstractWordFrequencySet.

◆ getStateMap()

virtual std::shared_ptr<const StateMapInterface> bpp::FrequencySetInterface::getStateMap ( ) const

pure virtualinherited

Returns: A shared_ptr toward the mapping of model states with alphabet states.

Implemented in bpp::AbstractFrequencySet.

◆ getWordAlphabet()

virtual std::shared_ptr<const CoreWordAlphabet> bpp::WordFrequencySetInterface::getWordAlphabet ( ) const

pure virtual

Implemented in bpp::AbstractWordFrequencySet.

◆ setFrequencies()

virtual void bpp::FrequencySetInterface::setFrequencies ( const std::vector< double > & frequencies )

pure virtualinherited

Set the parameters in order to match a given set of frequencies.

Parameters

frequencies The set of frequencies to match.

Exceptions

DimensionException	If the number of frequencies does not match the size of the alphabet.
Exception	If the frequencies do not sum to 1.

Implemented in bpp::WordFromUniqueFrequencySet, bpp::WordFromIndependentFrequencySet, bpp::FullNucleotideFrequencySet, bpp::GCFrequencySet, bpp::MvaFrequencySet, bpp::UserFrequencySet, bpp::FixedFrequencySet, bpp::MarkovModulatedFrequencySet, bpp::FromModelFrequencySet, bpp::FullFrequencySet, bpp::FullPerAACodonFrequencySet, bpp::UserCodonFrequencySet, bpp::FixedCodonFrequencySet, and bpp::FullCodonFrequencySet.

Referenced by bpp::BppOFrequencySetFormat::initialize_().

◆ setFrequenciesFromAlphabetStatesFrequencies()

virtual void bpp::FrequencySetInterface::setFrequenciesFromAlphabetStatesFrequencies ( const std::map< int, double > & frequencies )

pure virtualinherited

Set the Frequencies from the one of the map which keys match with a letter of the Alphabet. The frequencies are normalized so that the matching values sum 1.

Parameters

frequencies The set of frequencies to match.

Implemented in bpp::AbstractFrequencySet.

Referenced by bpp::BppOFrequencySetFormat::initialize_().

◆ stateMap()

virtual const StateMapInterface& bpp::FrequencySetInterface::stateMap ( ) const

pure virtualinherited

Returns: The mapping of model states with alphabet states.

Implemented in bpp::AbstractFrequencySet.

Member Data Documentation

◆ FREQUENCE_CONSTRAINT_CENTI

std::shared_ptr< IntervalConstraint > FrequencySetInterface::FREQUENCE_CONSTRAINT_CENTI

staticinherited

Definition at line 92 of file FrequencySet.h.

Referenced by bpp::FullNucleotideFrequencySet::FullNucleotideFrequencySet().

◆ FREQUENCE_CONSTRAINT_MILLI

std::shared_ptr< IntervalConstraint > FrequencySetInterface::FREQUENCE_CONSTRAINT_MILLI

staticinherited

Definition at line 91 of file FrequencySet.h.

◆ FREQUENCE_CONSTRAINT_SMALL

std::shared_ptr< IntervalConstraint > FrequencySetInterface::FREQUENCE_CONSTRAINT_SMALL

staticinherited

Definition at line 90 of file FrequencySet.h.

Referenced by bpp::F81::F81(), bpp::F84::F84(), bpp::GTR::GTR(), bpp::HKY85::HKY85(), bpp::T92::T92(), and bpp::TN93::TN93().

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

Bpp/Phyl/Model/FrequencySet/WordFrequencySet.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ alphabet()

◆ clone()

◆ frequencySetForLetter()

◆ getAlphabet()

◆ getAlphabetStatesFrequencies()

◆ getFrequencies()

◆ getLength()

◆ getName()

◆ getNumberOfFrequencies()

◆ getSizeFromVector()

◆ getStateMap()

◆ getWordAlphabet()

◆ setFrequencies()

◆ setFrequenciesFromAlphabetStatesFrequencies()

◆ stateMap()

Member Data Documentation

◆ FREQUENCE_CONSTRAINT_CENTI

◆ FREQUENCE_CONSTRAINT_MILLI

◆ FREQUENCE_CONSTRAINT_SMALL