bpp-phyl3
3.0.0
|
A frequencies set used to estimate frequencies at the root with the COaLA model. Frequencies at the root are optimized in the same way than the equlibrium frequencies on branches. Hyperparameters are used, which represent positions along the principal axes obtained from a preliminary Correspondence Analysis. From the optimized positions, the 20 frequencies are calculated. More...
#include <Bpp/Phyl/Model/FrequencySet/MvaFrequencySet.h>
Public Member Functions | |
MvaFrequencySet (std::shared_ptr< const ProteicAlphabet > alpha) | |
Constructor. More... | |
MvaFrequencySet * | clone () const override |
std::shared_ptr< const ProteicAlphabet > | getProteicAlphabet () const override |
void | setTransposeMatrixOfPpalAxes (const RowMatrix< double > &matrix) |
void | setMatrixOfRowCoords (const RowMatrix< double > &matrix) |
void | setNbrOfAxes (const size_t &nAxes) |
void | setModelName (const std::string &modelName) |
void | setVectorOfColumnWeights (const std::vector< double > &cw) |
void | setParamValues (std::map< std::string, std::string > &valuesSettings) |
void | setFrequencies (const std::vector< double > &frequencies) override |
Set the parameters in order to match a given set of frequencies. More... | |
void | defineParameters () |
void | fireParameterChanged (const ParameterList ¶meters) override |
void | updateFrequencies () |
void | initSet (const CoalaCore &coala) |
void | computeReversePCA (const std::vector< double > &positions, std::vector< double > &tmpFreqs) |
void | computeCoordsFirstSpacePCA (std::vector< double > &tmpFreqs, std::vector< double > &freqs) |
void | computeReverseCOA (const std::vector< double > &positions, std::vector< double > &tmpFreqs) |
void | computeCoordsFirstSpaceCOA (std::vector< double > &tmpFreqs, std::vector< double > &freqs) |
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 |
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 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 ParameterList & | getParameters_ ()=0 |
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 | |
RowMatrix< double > | tPpalAxes_ |
RowMatrix< double > | rowCoords_ |
size_t | nbrOfAxes_ |
std::string | model_ |
std::vector< double > | columnWeights_ |
std::map< std::string, std::string > | paramValues_ |
Private Attributes | |
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_ |
A frequencies set used to estimate frequencies at the root with the COaLA model. Frequencies at the root are optimized in the same way than the equlibrium frequencies on branches. Hyperparameters are used, which represent positions along the principal axes obtained from a preliminary Correspondence Analysis. From the optimized positions, the 20 frequencies are calculated.
Definition at line 21 of file MvaFrequencySet.h.
MvaFrequencySet::MvaFrequencySet | ( | std::shared_ptr< const ProteicAlphabet > | alpha | ) |
|
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::ProteinFrequencySetInterface.
Definition at line 31 of file MvaFrequencySet.h.
References MvaFrequencySet().
void MvaFrequencySet::computeCoordsFirstSpaceCOA | ( | std::vector< double > & | tmpFreqs, |
std::vector< double > & | freqs | ||
) |
Definition at line 113 of file MvaFrequencySet.cpp.
References columnWeights_.
Referenced by updateFrequencies().
void bpp::MvaFrequencySet::computeCoordsFirstSpacePCA | ( | std::vector< double > & | tmpFreqs, |
std::vector< double > & | freqs | ||
) |
void MvaFrequencySet::computeReverseCOA | ( | const std::vector< double > & | positions, |
std::vector< double > & | tmpFreqs | ||
) |
Definition at line 102 of file MvaFrequencySet.cpp.
References nbrOfAxes_, and tPpalAxes_.
Referenced by updateFrequencies().
void bpp::MvaFrequencySet::computeReversePCA | ( | const std::vector< double > & | positions, |
std::vector< double > & | tmpFreqs | ||
) |
void MvaFrequencySet::defineParameters | ( | ) |
Definition at line 35 of file MvaFrequencySet.cpp.
References bpp::AbstractParameterAliasable::addParameter_(), RowMatrix< double >::col(), bpp::AbstractParameterAliasable::getNamespace(), bpp::VectorTools::max(), bpp::VectorTools::min(), nbrOfAxes_, paramValues_, rowCoords_, bpp::TextTools::toDouble(), and bpp::TextTools::toString().
Referenced by initSet().
|
overridevirtual |
Reimplemented from bpp::AbstractParameterAliasable.
Definition at line 51 of file MvaFrequencySet.cpp.
References updateFrequencies().
|
pure virtualinherited |
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().
|
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(), 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.
|
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(), bpp::UserCodonFrequencySet::setFrequencies(), bpp::GCFrequencySet::setFrequencies(), bpp::FullCodonFrequencySet::updateFreq_(), bpp::FullFrequencySet::updateFreq_(), 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 updateFrequencies().
|
inlineprotectedinherited |
Definition at line 178 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::UserFrequencySet::readFromFile_().
|
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().
|
inlineoverridevirtual |
Implements bpp::ProteinFrequencySetInterface.
Definition at line 56 of file MvaFrequencySet.h.
References bpp::AbstractFrequencySet::getAlphabet().
|
pure virtualinherited |
Implemented in bpp::AbstractFrequencySet.
|
inlineoverridevirtualinherited |
Implements bpp::FrequencySetInterface.
Definition at line 146 of file FrequencySet.h.
References bpp::AbstractFrequencySet::stateMap_.
void MvaFrequencySet::initSet | ( | const CoalaCore & | coala | ) |
Definition at line 25 of file MvaFrequencySet.cpp.
References defineParameters(), bpp::CoalaCore::getColumnWeights(), bpp::CoalaCore::getNbrOfAxes(), bpp::CoalaCore::getRowCoordinates(), bpp::CoalaCore::getTppalAxesMatrix(), setMatrixOfRowCoords(), setNbrOfAxes(), setTransposeMatrixOfPpalAxes(), setVectorOfColumnWeights(), and updateFrequencies().
|
inlineinherited |
Definition at line 167 of file FrequencySet.h.
References bpp::AbstractFrequencySet::freq_.
Referenced by bpp::FullPerAACodonFrequencySet::updateFrequencies_().
|
overridevirtual |
Set the parameters in order to match a given set of frequencies.
frequencies | The set of frequencies to match. |
DimensionException | If the number of frequencies does not match the size of the alphabet. |
Exception | If the frequencies do not sum to 1. |
Implements bpp::FrequencySetInterface.
Definition at line 99 of file MvaFrequencySet.cpp.
|
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 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_().
|
inline |
|
inline |
Definition at line 64 of file MvaFrequencySet.h.
References model_.
|
inline |
|
inline |
Definition at line 66 of file MvaFrequencySet.h.
References paramValues_.
|
inline |
|
inline |
Definition at line 65 of file MvaFrequencySet.h.
References columnWeights_.
Referenced by initSet().
|
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_().
void MvaFrequencySet::updateFrequencies | ( | ) |
Definition at line 56 of file MvaFrequencySet.cpp.
References computeCoordsFirstSpaceCOA(), computeReverseCOA(), bpp::AbstractFrequencySet::getFreq_(), bpp::AbstractFrequencySet::getFrequencies(), bpp::AbstractParameterAliasable::getParameterValue(), nbrOfAxes_, bpp::AbstractFrequencySet::setFrequencies_(), bpp::VectorTools::sum(), and bpp::TextTools::toString().
Referenced by fireParameterChanged(), and initSet().
|
privateinherited |
Definition at line 104 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::alphabet(), bpp::AbstractFrequencySet::getAlphabet(), and bpp::AbstractFrequencySet::operator=().
|
protected |
Definition at line 52 of file MvaFrequencySet.h.
Referenced by computeCoordsFirstSpaceCOA(), and setVectorOfColumnWeights().
|
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().
|
protected |
Definition at line 51 of file MvaFrequencySet.h.
Referenced by setModelName().
|
privateinherited |
Definition at line 107 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::getName(), and bpp::AbstractFrequencySet::operator=().
|
protected |
Definition at line 50 of file MvaFrequencySet.h.
Referenced by computeReverseCOA(), defineParameters(), setNbrOfAxes(), and updateFrequencies().
|
protected |
Definition at line 53 of file MvaFrequencySet.h.
Referenced by defineParameters(), and setParamValues().
|
protected |
Definition at line 49 of file MvaFrequencySet.h.
Referenced by defineParameters(), and setMatrixOfRowCoords().
|
privateinherited |
Definition at line 105 of file FrequencySet.h.
Referenced by bpp::AbstractFrequencySet::getStateMap(), bpp::AbstractFrequencySet::operator=(), and bpp::AbstractFrequencySet::stateMap().
|
protected |
Definition at line 48 of file MvaFrequencySet.h.
Referenced by computeReverseCOA(), and setTransposeMatrixOfPpalAxes().