bpp-phyl3
3.0.0
|
#include <Bpp/Phyl/Model/FrequencySet/CodonFrequencySet.h>
Public Member Functions | |
UserCodonFrequencySet (std::shared_ptr< const GeneticCode > gCode, const std::string &path, size_t nCol=1) | |
UserCodonFrequencySet (const UserCodonFrequencySet &fcfs) | |
UserCodonFrequencySet & | operator= (const UserCodonFrequencySet &fcfs) |
UserCodonFrequencySet * | clone () const override |
std::shared_ptr< const GeneticCode > | getGeneticCode () const override |
std::shared_ptr< const CodonAlphabet > | getCodonAlphabet () const override |
void | setFrequencies (const std::vector< double > &frequencies) override |
the given frequencies are normalized such thaat the sum of the frequencies on the non-stop codons equals 1. 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 | 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 ¶meters)=0 |
virtual void | setParameterValue (const std::string &name, double value)=0 |
virtual void | setParametersValues (const ParameterList ¶meters)=0 |
virtual bool | matchParametersValues (const ParameterList ¶meters)=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 |
const std::string & | getPath () const |
size_t | getColumnNumber () const |
std::shared_ptr< const Alphabet > | getAlphabet () const override |
const Alphabet & | alphabet () const override |
const StateMapInterface & | stateMap () const override |
std::shared_ptr< const StateMapInterface > | getStateMap () const override |
const Vdouble & | getFrequencies () const override |
const std::map< int, double > | getAlphabetStatesFrequencies () const override |
void | setFrequenciesFromAlphabetStatesFrequencies (const std::map< int, double > &frequencies) override |
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... | |
size_t | getNumberOfFrequencies () const override |
std::string | getName () const override |
void | normalize () |
size_t | getNumberOfIndependentParameters () const |
void | aliasParameters (const std::string &p1, const std::string &p2) |
void | aliasParameters (std::map< std::string, std::string > &unparsedParams, bool verbose) |
void | unaliasParameters (const std::string &p1, const std::string &p2) |
const ParameterList & | getIndependentParameters () const |
virtual std::vector< std::string > | getAlias (const std::string &name) const |
virtual std::map< std::string, std::string > | getAliases () const |
bool | hasParameter (const std::string &name) const override |
const ParameterList & | getParameters () const override |
const Parameter & | parameter (const std::string &name) const override |
double | getParameterValue (const std::string &name) const override |
void | setAllParametersValues (const ParameterList ¶meters) override |
void | setParameterValue (const std::string &name, double value) override |
void | setParametersValues (const ParameterList ¶meters) override |
bool | matchParametersValues (const ParameterList ¶meters) override |
void | removeConstraint (const std::string &name) override |
void | setConstraint (const std::string &name, std::shared_ptr< ConstraintInterface > constraint) override |
size_t | getNumberOfParameters () const override |
void | setNamespace (const std::string &prefix) |
std::string | getNamespace () const override |
std::string | getParameterNameWithoutNamespace (const std::string &name) const override |
bool | hasIndependentParameter (const std::string &name) const |
ParameterList | getAliasedParameters (const ParameterList &pl) const |
ParameterList | getFromParameters (const ParameterList &pl) const |
std::string | getFrom (const std::string &name) const |
const std::shared_ptr< Parameter > & | getParameter (const std::string &name) const |
Static Public Member Functions | |
static std::unique_ptr< CodonFrequencySetInterface > | getFrequencySetForCodons (short option, std::shared_ptr< const GeneticCode > gCode, const std::string &mgmtStopCodon="quadratic", unsigned short method=1) |
A helper function that provide frequencies set for codon models according to PAML option. More... | |
Static Public Attributes | |
static const short | F0 = 0 |
static const short | F1X4 = 1 |
static const short | F3X4 = 2 |
static const short | F61 = 3 |
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 | |
void | fireParameterChanged (const ParameterList ¶meters) override |
virtual ParameterList & | getParameters_ ()=0 |
void | readFromFile_ () |
std::vector< double > & | getFrequencies_ () |
double & | getFreq_ (size_t i) |
const double & | getFreq_ (size_t i) const |
void | setFrequencies_ (const std::vector< double > &frequencies) |
ParameterList & | getParameters_ () override |
const std::shared_ptr< Parameter > & | getParameter (size_t i) const |
std::shared_ptr< Parameter > & | getParameter (size_t i) |
void | addParameter_ (Parameter *parameter) |
void | addParameters_ (const ParameterList ¶meters) |
void | shareParameter_ (const std::shared_ptr< Parameter > ¶meter) |
void | shareParameters_ (const ParameterList ¶meters) |
void | includeParameters_ (const ParameterList ¶meters) |
void | deleteParameter_ (size_t index) |
void | deleteParameter_ (std::string &name) |
void | deleteParameters_ (const std::vector< std::string > &names) |
void | resetParameters_ () |
Parameter & | getParameter_ (const std::string &name) |
Parameter & | getParameter_ (size_t index) |
const Parameter & | getParameter_ (size_t index) const |
Parameter & | getParameterWithNamespace_ (const std::string &name) |
const Parameter & | getParameterWithNamespace_ (const std::string &name) const |
Protected Attributes | |
std::shared_ptr< const GeneticCode > | pgc_ |
Private Attributes | |
std::string | path_ |
size_t | nCol_ |
std::shared_ptr< const Alphabet > | alphabet_ |
std::shared_ptr< const StateMapInterface > | stateMap_ |
std::vector< double > | freq_ |
std::string | name_ |
ParameterList | independentParameters_ |
std::map< std::string, std::shared_ptr< AliasParameterListener > > | aliasListenersRegister_ |
ParameterList | parameters_ |
std::string | prefix_ |
Definition at line 197 of file CodonFrequencySet.h.
UserCodonFrequencySet::UserCodonFrequencySet | ( | std::shared_ptr< const GeneticCode > | gCode, |
const std::string & | path, | ||
size_t | nCol = 1 |
||
) |
Definition at line 362 of file CodonFrequencySet.cpp.
Referenced by clone().
|
inline |
Definition at line 210 of file CodonFrequencySet.h.
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 142 of file FrequencySet.h.
References bpp::AbstractFrequencySet::alphabet_.
|
inlineoverridevirtual |
Implements bpp::CodonFrequencySetInterface.
Definition at line 222 of file CodonFrequencySet.h.
References UserCodonFrequencySet().
|
inlineoverrideprotectedvirtual |
Reimplemented from bpp::AbstractParameterAliasable.
Definition at line 239 of file CodonFrequencySet.h.
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
Referenced by getCodonAlphabet(), bpp::FixedNucleotideFrequencySet::getNucleicAlphabet(), bpp::UserNucleotideFrequencySet::getNucleicAlphabet(), bpp::FullProteinFrequencySet::getProteicAlphabet(), bpp::FixedProteinFrequencySet::getProteicAlphabet(), and bpp::UserProteinFrequencySet::getProteicAlphabet().
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 140 of file FrequencySet.h.
References bpp::AbstractFrequencySet::alphabet_.
Referenced by bpp::FullCodonFrequencySet::getCodonAlphabet(), bpp::FixedCodonFrequencySet::getCodonAlphabet(), bpp::FullPerAACodonFrequencySet::getCodonAlphabet(), bpp::CodonFromIndependentFrequencySet::getCodonAlphabet(), bpp::GCFrequencySet::getNucleicAlphabet(), bpp::FullNucleotideFrequencySet::getNucleicAlphabet(), bpp::MvaFrequencySet::getProteicAlphabet(), bpp::AbstractWordFrequencySet::getWordAlphabet(), bpp::UserFrequencySet::readFromFile_(), bpp::FullCodonFrequencySet::setFrequencies(), and bpp::FullFrequencySet::updateFreq_().
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
|
overridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 57 of file FrequencySet.cpp.
|
inlineoverridevirtual |
Implements bpp::CodonFrequencySetInterface.
Definition at line 227 of file CodonFrequencySet.h.
References bpp::FrequencySetInterface::getAlphabet().
Referenced by setFrequencies().
|
inlineinherited |
Definition at line 408 of file FrequencySet.h.
References bpp::UserFrequencySet::nCol_.
|
inlineprotectedinherited |
Definition at line 179 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::GCFrequencySet::fireParameterChanged(), bpp::FullNucleotideFrequencySet::fireParameterChanged(), bpp::FixedCodonFrequencySet::FixedCodonFrequencySet(), bpp::FullNucleotideFrequencySet::FullNucleotideFrequencySet(), bpp::GCFrequencySet::GCFrequencySet(), bpp::UserFrequencySet::readFromFile_(), bpp::FixedCodonFrequencySet::setFrequencies(), setFrequencies(), bpp::GCFrequencySet::setFrequencies(), bpp::FullCodonFrequencySet::updateFreq_(), bpp::FullFrequencySet::updateFreq_(), bpp::MvaFrequencySet::updateFrequencies(), bpp::WordFromIndependentFrequencySet::updateFrequencies(), bpp::WordFromUniqueFrequencySet::updateFrequencies(), bpp::CodonFromIndependentFrequencySet::updateFrequencies(), bpp::CodonFromUniqueFrequencySet::updateFrequencies(), and bpp::FullPerAACodonFrequencySet::updateFrequencies_().
|
inlineprotectedinherited |
Definition at line 180 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
|
pure virtualinherited |
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().
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 148 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::MvaFrequencySet::updateFrequencies().
|
inlineprotectedinherited |
Definition at line 178 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::UserFrequencySet::readFromFile_().
|
staticinherited |
A helper function that provide frequencies set for codon models according to PAML option.
option | A code describing the option, one of F61, F1X4 or F3X4. |
gCode | The genetic code to use. The underlying codon alphabet object will be passed to the FrequencySet instance. |
mgmtStopCodon | the optional way the frequencies assigned to the stop codons are redistributed to the other codons, with F1X4 and F3X4 options. The available values are:
|
method | The parametrization used for F61. Default method is 1 (ie global ratio). |
Definition at line 641 of file CodonFrequencySet.cpp.
References bpp::CodonFrequencySetInterface::F0, bpp::CodonFrequencySetInterface::F1X4, bpp::CodonFrequencySetInterface::F3X4, and bpp::CodonFrequencySetInterface::F61.
Referenced by bpp::BppOFrequencySetFormat::readFrequencySet().
|
inlineoverridevirtual |
Implements bpp::CodonFrequencySetInterface.
Definition at line 225 of file CodonFrequencySet.h.
References pgc_.
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
Referenced by bpp::BppOFrequencySetFormat::writeFrequencySet().
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 165 of file FrequencySet.h.
References bpp::AbstractFrequencySet::name_.
Referenced by bpp::WordFromIndependentFrequencySet::getDescription(), and bpp::WordFromUniqueFrequencySet::getDescription().
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 163 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::FromModelFrequencySet::setFrequencies(), bpp::FixedFrequencySet::setFrequencies(), and bpp::UserFrequencySet::setFrequencies().
|
inlineinherited |
Definition at line 406 of file FrequencySet.h.
References bpp::UserFrequencySet::path_.
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 146 of file FrequencySet.h.
References bpp::AbstractFrequencySet::stateMap_.
|
inlineinherited |
Definition at line 167 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::FullPerAACodonFrequencySet::updateFrequencies_().
|
inline |
Definition at line 215 of file CodonFrequencySet.h.
References bpp::UserFrequencySet::operator=(), and pgc_.
|
protectedinherited |
Definition at line 282 of file FrequencySet.cpp.
References bpp::ApplicationTools::displayMessage(), bpp::FileTools::fileExists(), bpp::AbstractFrequencySet::getAlphabet(), bpp::AbstractFrequencySet::getFreq_(), bpp::AbstractFrequencySet::getFrequencies_(), bpp::FileTools::getNextLine(), bpp::StringTokenizer::hasMoreToken(), bpp::UserFrequencySet::nCol_, bpp::StringTokenizer::nextToken(), bpp::UserFrequencySet::path_, bpp::VectorTools::sum(), bpp::TextTools::toDouble(), and bpp::TextTools::toString().
Referenced by bpp::UserFrequencySet::UserFrequencySet().
|
overridevirtual |
the given frequencies are normalized such thaat the sum of the frequencies on the non-stop codons equals 1.
Implements bpp::FrequencySetInterface.
Definition at line 373 of file CodonFrequencySet.cpp.
References getCodonAlphabet(), bpp::AbstractFrequencySet::getFreq_(), and pgc_.
|
inlineprotectedinherited |
Definition at line 181 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::FromModelFrequencySet::fireParameterChanged(), bpp::MarkovModulatedFrequencySet::fireParameterChanged(), bpp::FixedFrequencySet::FixedFrequencySet(), bpp::FromModelFrequencySet::FromModelFrequencySet(), bpp::MarkovModulatedFrequencySet::MarkovModulatedFrequencySet(), bpp::FixedFrequencySet::setFrequencies(), bpp::UserFrequencySet::setFrequencies(), bpp::FullNucleotideFrequencySet::setFrequencies(), and bpp::MvaFrequencySet::updateFrequencies().
|
overridevirtualinherited |
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.
In this implementation, all model states with the same alphabet state are given the same frequency.
frequencies | The set of frequencies to match. |
Implements bpp::FrequencySetInterface.
Definition at line 28 of file FrequencySet.cpp.
|
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.
frequencies | The set of frequencies to match. |
Implemented in bpp::AbstractFrequencySet.
Referenced by bpp::BppOFrequencySetFormat::initialize_().
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 144 of file FrequencySet.h.
References bpp::AbstractFrequencySet::stateMap_.
Referenced by bpp::FixedFrequencySet::FixedFrequencySet(), bpp::FullFrequencySet::FullFrequencySet(), bpp::FromModelFrequencySet::setFrequencies(), and bpp::FullPerAACodonFrequencySet::updateFrequencies_().
|
privateinherited |
Definition at line 104 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::alphabet(), bpp::AbstractFrequencySet::getAlphabet(), and bpp::AbstractFrequencySet::operator=().
|
staticinherited |
Definition at line 62 of file CodonFrequencySet.h.
Referenced by bpp::CodonFrequencySetInterface::getFrequencySetForCodons(), and bpp::BppOFrequencySetFormat::readFrequencySet().
|
staticinherited |
Definition at line 63 of file CodonFrequencySet.h.
Referenced by bpp::CodonFrequencySetInterface::getFrequencySetForCodons(), and bpp::BppOFrequencySetFormat::readFrequencySet().
|
staticinherited |
Definition at line 64 of file CodonFrequencySet.h.
Referenced by bpp::CodonFrequencySetInterface::getFrequencySetForCodons(), and bpp::BppOFrequencySetFormat::readFrequencySet().
|
staticinherited |
Definition at line 65 of file CodonFrequencySet.h.
Referenced by bpp::CodonFrequencySetInterface::getFrequencySetForCodons(), and bpp::BppOFrequencySetFormat::readFrequencySet().
|
privateinherited |
Definition at line 106 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::getFreq_(), bpp::AbstractFrequencySet::getFrequencies(), bpp::AbstractFrequencySet::getFrequencies_(), bpp::AbstractFrequencySet::getNumberOfFrequencies(), bpp::AbstractFrequencySet::normalize(), bpp::AbstractFrequencySet::operator=(), and bpp::AbstractFrequencySet::setFrequencies_().
|
staticinherited |
Definition at line 92 of file FrequencySet.h.
Referenced by bpp::FullNucleotideFrequencySet::FullNucleotideFrequencySet().
|
staticinherited |
Definition at line 91 of file FrequencySet.h.
|
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().
|
privateinherited |
Definition at line 107 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::getName(), and bpp::AbstractFrequencySet::operator=().
|
privateinherited |
Definition at line 389 of file FrequencySet.h.
Referenced by bpp::UserFrequencySet::getColumnNumber(), bpp::UserFrequencySet::operator=(), and bpp::UserFrequencySet::readFromFile_().
|
privateinherited |
Definition at line 388 of file FrequencySet.h.
Referenced by bpp::UserFrequencySet::getPath(), bpp::UserFrequencySet::operator=(), and bpp::UserFrequencySet::readFromFile_().
|
protected |
Definition at line 202 of file CodonFrequencySet.h.
Referenced by getGeneticCode(), operator=(), and setFrequencies().
|
privateinherited |
Definition at line 105 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::getStateMap(), bpp::AbstractFrequencySet::operator=(), and bpp::AbstractFrequencySet::stateMap().