|
bpp-phyl3 3.0.0
|
Abstract class of Wrapping model class, where all methods are redirected from model(). More...
#include <Bpp/Phyl/Model/AbstractWrappedModel.h>
Inheritance diagram for bpp::AbstractWrappedModel:
Collaboration diagram for bpp::AbstractWrappedModel:Public Member Functions | |
| AbstractWrappedModel (const std::string &prefix) | |
| virtual | ~AbstractWrappedModel () |
| virtual std::string | getName () const override |
| Get the name of the model. More... | |
| void | setNamespace (const std::string &prefix) |
| bool | hasIndependentParameter (const std::string &name) const |
| const ParameterList & | getIndependentParameters () const |
| 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) |
| ParameterList | getAliasedParameters (const ParameterList &pl) const |
| ParameterList | getFromParameters (const ParameterList &pl) const |
| virtual std::vector< std::string > | getAlias (const std::string &name) const |
| virtual std::map< std::string, std::string > | getAliases () const |
| std::string | getFrom (const std::string &name) const |
| bool | hasParameter (const std::string &name) const override |
| const ParameterList & | getParameters () const override |
| const Parameter & | parameter (const std::string &name) const override |
| const std::shared_ptr< Parameter > & | getParameter (const std::string &name) const |
| 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 |
| std::string | getNamespace () const override |
| std::string | getParameterNameWithoutNamespace (const std::string &name) const override |
| virtual void | fireParameterChanged (const ParameterList ¶meters) |
| virtual Clonable * | clone () const=0 |
| virtual const BranchModelInterface & | model () const =0 |
| BranchModelInterface * | clone () const =0 |
| virtual double | getInitValue (size_t i, int state) const =0 |
| virtual const Eigen::VectorXd & | Lik_t (const Eigen::VectorXd &values, double t) const =0 |
| virtual const Eigen::VectorXd & | dLik_dt (const Eigen::VectorXd &values, double t) const =0 |
| virtual const Eigen::VectorXd & | d2Lik_dt2 (const Eigen::VectorXd &values, double t) const =0 |
| virtual double | getRate () const =0 |
| Get the rate. More... | |
| virtual void | setRate (double rate)=0 |
| Set the rate of the model (must be positive). More... | |
| virtual void | addRateParameter ()=0 |
| const std::vector< int > & | getAlphabetStates () const override |
| const StateMapInterface & | stateMap () const override |
| std::shared_ptr< const StateMapInterface > | getStateMap () const override |
| int | getAlphabetStateAsInt (size_t i) const override |
| std::string | getAlphabetStateAsChar (size_t i) const override |
| std::vector< size_t > | getModelStates (int code) const override |
| Get the state in the model corresponding to a particular state in the alphabet. More... | |
| std::vector< size_t > | getModelStates (const std::string &code) const override |
| Get the state in the model corresponding to a particular state in the alphabet. More... | |
| const Alphabet & | alphabet () const override |
| std::shared_ptr< const Alphabet > | getAlphabet () const override |
| size_t | getNumberOfStates () const override |
| Get the number of states. More... | |
| const FrequencySetInterface & | frequencySet () const override |
Protected Member Functions | |
| 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 |
| ParameterList & | getParameters_ () override |
Private Attributes | |
| ParameterList | independentParameters_ |
| std::map< std::string, std::shared_ptr< AliasParameterListener > > | aliasListenersRegister_ |
| ParameterList | parameters_ |
| std::string | prefix_ |
Abstract class of Wrapping model class, where all methods are redirected from model().
Definition at line 21 of file AbstractWrappedModel.h.
|
inline |
Definition at line 26 of file AbstractWrappedModel.h.
|
inlinevirtual |
Definition at line 30 of file AbstractWrappedModel.h.
|
pure virtualinherited |
Implemented in bpp::AbstractBiblioTransitionModel, bpp::AbstractFromSubstitutionModelTransitionModel, bpp::AbstractTransitionModel, bpp::FromMixtureSubstitutionModel, bpp::G2001, bpp::InMixedSubstitutionModel, bpp::MultinomialFromTransitionModel, bpp::RegisterRatesSubstitutionModel, bpp::TransitionFromTransitionModel, and bpp::TS98.
Referenced by bpp::AbstractBiblioTransitionModel::addRateParameter(), bpp::AbstractFromSubstitutionModelTransitionModel::addRateParameter(), bpp::FromMixtureSubstitutionModel::addRateParameter(), bpp::InMixedSubstitutionModel::addRateParameter(), bpp::MultinomialFromTransitionModel::addRateParameter(), bpp::TransitionFromTransitionModel::addRateParameter(), and bpp::BppOSubstitutionModelFormat::updateParameters_().
|
inlineoverridevirtual |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 53 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::alphabet(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::alphabet(), and bpp::OneChangeRegisterTransitionModel::OneChangeRegisterTransitionModel().
|
pure virtualinherited |
Implements bpp::ParameterAliasable.
Implemented in bpp::BinarySubstitutionModel, bpp::CodonDistanceSubstitutionModel, bpp::F84, bpp::HKY85, bpp::LG10_EX_EHO::EmbeddedModel, bpp::LG10_EX_EHO, bpp::TwoParameterBinarySubstitutionModel, bpp::TransitionModelInterface, bpp::AnonymousSubstitutionModel, bpp::CodonAdHocSubstitutionModel, bpp::CodonDistanceFrequenciesSubstitutionModel, bpp::CodonDistancePhaseFrequenciesSubstitutionModel, bpp::CodonSameAARateSubstitutionModel, bpp::DFP07, bpp::DFPDistanceFrequenciesSubstitutionModel, bpp::GY94, bpp::KCM, bpp::KroneckerCodonDistanceFrequenciesSubstitutionModel, bpp::KroneckerCodonDistanceSubstitutionModel, bpp::MG94, bpp::RELAX, bpp::SENCA, bpp::TripletSubstitutionModel, bpp::YN98, bpp::YNGP_M1, bpp::YNGP_M10, bpp::YNGP_M2, bpp::YNGP_M3, bpp::YNGP_M7, bpp::YNGP_M8, bpp::YNGP_M9, bpp::D1WalkSubstitutionModel, bpp::EquiprobableSubstitutionModel, bpp::FromMixtureSubstitutionModel, bpp::G2001, bpp::InMixedSubstitutionModel, bpp::KroneckerWordSubstitutionModel, bpp::MixtureOfASubstitutionModel, bpp::MixtureOfATransitionModel, bpp::MixtureOfSubstitutionModels, bpp::MixtureOfTransitionModels, bpp::MultinomialFromTransitionModel, bpp::F81, bpp::gBGC, bpp::GTR, bpp::JCnuc, bpp::K80, bpp::L95, bpp::RN95, bpp::RN95s, bpp::SSR, bpp::T92, bpp::TN93, bpp::YpR_Sym, bpp::YpR_Gen, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, bpp::POMO, bpp::Coala, bpp::DSO78, bpp::JCprot, bpp::JTT92, bpp::LG08, bpp::LGL08_CAT::EmbeddedModel, bpp::LGL08_CAT, bpp::LLG08_EHO::EmbeddedModel, bpp::LLG08_EHO, bpp::LLG08_EX2::EmbeddedModel, bpp::LLG08_EX2, bpp::LLG08_EX3::EmbeddedModel, bpp::LLG08_EX3, bpp::LLG08_UL2::EmbeddedModel, bpp::LLG08_UL2, bpp::LLG08_UL3::EmbeddedModel, bpp::LLG08_UL3, bpp::UserProteinSubstitutionModel, bpp::WAG01, bpp::RE08, bpp::RE08Nucleotide, bpp::RE08Protein, bpp::RE08Codon, bpp::RegisterRatesSubstitutionModel, bpp::TransitionFromTransitionModel, bpp::TS98, bpp::WordSubstitutionModel, bpp::AbstractMixedTransitionModel, bpp::AbstractReversibleSubstitutionModel, bpp::AbstractCodonSubstitutionModel, bpp::AbstractDFPSubstitutionModel, bpp::AbstractKroneckerCodonSubstitutionModel, bpp::CodonSubstitutionModelInterface, bpp::CodonReversibleSubstitutionModelInterface, bpp::YNGP_M, bpp::MarkovModulatedSubstitutionModel, bpp::MixedTransitionModelInterface, bpp::NucleotideSubstitutionModelInterface, bpp::NucleotideReversibleSubstitutionModelInterface, bpp::AbstractNucleotideSubstitutionModel, bpp::AbstractReversibleNucleotideSubstitutionModel, bpp::ProteinSubstitutionModelInterface, bpp::ProteinReversibleSubstitutionModelInterface, bpp::AbstractProteinSubstitutionModel, bpp::AbstractReversibleProteinSubstitutionModel, bpp::SubstitutionModelInterface, and bpp::ReversibleSubstitutionModelInterface.
Referenced by bpp::SubstitutionProcessCollection::addOnePerBranchSubstitutionProcess(), and bpp::NonHomogeneousSubstitutionProcess::createNonHomogeneousSubstitutionProcess().
|
pure virtualinherited |
|
pure virtualinherited |
|
inlineoverridevirtual |
| Exception | if no FrequenceSet is associated to this model. |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::AbstractWrappedTransitionModel, bpp::YN98, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, and bpp::RegisterRatesSubstitutionModel.
Definition at line 59 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::frequencySet(), and bpp::WrappedModelInterface::model().
Referenced by bpp::YN98::frequencySet().
|
inlineoverridevirtual |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 55 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getAlphabet(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabet(), and bpp::OneChangeRegisterTransitionModel::OneChangeRegisterTransitionModel().
|
inlineoverridevirtual |
| index | The model state. |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 46 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getAlphabetStateAsChar(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabetStateAsChar().
|
inlineoverridevirtual |
| index | The model state. |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 44 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getAlphabetStateAsInt(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabetStateAsInt().
|
inlineoverridevirtual |
@ brief Methods to supersede TransitionModel methods.
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 38 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getAlphabetStates(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::getAlphabetStates().
|
pure virtualinherited |
This method is used to initialize likelihoods in recursions. It typically sends 1 if i = state, 0 otherwise, where i is one of the possible states of the alphabet allowed in the model and state is the observed state in the considered sequence/site.
| i | the index of the state in the model. |
| state | An observed state in the sequence/site. |
| IndexOutOfBoundsException | if array position is out of range. |
| BadIntException | if states are not allowed in the associated alphabet. |
Implemented in bpp::AbstractTransitionModel, bpp::AbstractTotallyWrappedTransitionModel, bpp::InMixedSubstitutionModel, bpp::MarkovModulatedSubstitutionModel, bpp::MultinomialFromTransitionModel, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, bpp::RE08, and bpp::TransitionFromTransitionModel.
Referenced by bpp::AbstractTotallyWrappedTransitionModel::getInitValue(), bpp::InMixedSubstitutionModel::getInitValue(), bpp::MultinomialFromTransitionModel::getInitValue(), bpp::OneChangeRegisterTransitionModel::getInitValue(), bpp::OneChangeTransitionModel::getInitValue(), and bpp::TransitionFromTransitionModel::getInitValue().
|
inlineoverridevirtual |
Get the state in the model corresponding to a particular state in the alphabet.
| code | The alphabet state to check. |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 50 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getModelStates(), and bpp::WrappedModelInterface::model().
|
inlineoverridevirtual |
Get the state in the model corresponding to a particular state in the alphabet.
| code | The alphabet state to check. |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 48 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getModelStates(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::getModelStates().
|
inlineoverridevirtual |
Get the name of the model.
Implements bpp::BranchModelInterface.
Reimplemented in bpp::LG10_EX_EHO, bpp::DFP07, bpp::GY94, bpp::KCM, bpp::MG94, bpp::RELAX, bpp::YN98, bpp::YNGP_M1, bpp::YNGP_M10, bpp::YNGP_M2, bpp::YNGP_M3, bpp::YNGP_M7, bpp::YNGP_M8, bpp::YNGP_M9, bpp::FromMixtureSubstitutionModel, bpp::InMixedSubstitutionModel, bpp::MultinomialFromTransitionModel, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, bpp::LGL08_CAT, bpp::LLG08_EHO, bpp::LLG08_EX2, bpp::LLG08_EX3, bpp::LLG08_UL2, bpp::LLG08_UL3, bpp::RegisterRatesSubstitutionModel, and bpp::TransitionFromTransitionModel.
Definition at line 67 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getName(), and bpp::WrappedModelInterface::model().
Referenced by bpp::AbstractBiblioTransitionModel::updateMatrices_().
|
inlineoverridevirtual |
Get the number of states.
For most models, this equals the size of the alphabet.
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 57 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getNumberOfStates(), and bpp::WrappedModelInterface::model().
|
pure virtualinherited |
Get the rate.
Implemented in bpp::AbstractTransitionModel, bpp::AbstractTotallyWrappedTransitionModel, bpp::G2001, bpp::InMixedSubstitutionModel, bpp::MarkovModulatedSubstitutionModel, bpp::MultinomialFromTransitionModel, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, bpp::RegisterRatesSubstitutionModel, bpp::TransitionFromTransitionModel, and bpp::TS98.
Referenced by bpp::AbstractFromSubstitutionModelTransitionModel::addRateParameter(), bpp::OneChangeRegisterTransitionModel::d2Pij_dt2(), bpp::OneChangeTransitionModel::d2Pij_dt2(), bpp::OneChangeRegisterTransitionModel::dPij_dt(), bpp::OneChangeTransitionModel::dPij_dt(), bpp::OneChangeRegisterTransitionModel::getd2Pij_dt2(), bpp::OneChangeTransitionModel::getd2Pij_dt2(), bpp::OneChangeRegisterTransitionModel::getdPij_dt(), bpp::OneChangeTransitionModel::getdPij_dt(), bpp::OneChangeRegisterTransitionModel::getPij_t(), bpp::OneChangeTransitionModel::getPij_t(), bpp::AbstractTotallyWrappedTransitionModel::getRate(), bpp::InMixedSubstitutionModel::getRate(), bpp::MultinomialFromTransitionModel::getRate(), bpp::OneChangeRegisterTransitionModel::getRate(), bpp::OneChangeTransitionModel::getRate(), bpp::RegisterRatesSubstitutionModel::getRate(), bpp::TransitionFromTransitionModel::getRate(), and bpp::OneChangeTransitionModel::Pij_t().
|
inlineoverridevirtual |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 42 of file AbstractWrappedModel.h.
References bpp::BranchModelInterface::getStateMap(), and bpp::WrappedModelInterface::model().
Referenced by bpp::RegisterRatesSubstitutionModel::getStateMap().
|
pure virtualinherited |
This method is used to compute likelihoods in recursions. It computes the probability of a vector given a start state.
| values | An vector of states on the site. |
| t | time |
| IndexOutOfBoundsException | if array position is out of range. |
| BadIntException | if states are not allowed in the associated alphabet. |
Implemented in bpp::MultinomialFromTransitionModel, bpp::TransitionFromTransitionModel, bpp::TransitionModelInterface, and bpp::AbstractLkTransitionModel.
|
pure virtualinherited |
Implemented in bpp::AbstractFromSubstitutionModelTransitionModel, bpp::AbstractWrappedTransitionModel, bpp::MultinomialFromTransitionModel, and bpp::TransitionFromTransitionModel.
Referenced by alphabet(), frequencySet(), getAlphabet(), getAlphabetStateAsChar(), getAlphabetStateAsInt(), getAlphabetStates(), getModelStates(), getName(), getNumberOfStates(), getStateMap(), and stateMap().
|
pure virtualinherited |
Set the rate of the model (must be positive).
| rate | must be positive. |
Implemented in bpp::AbstractMixedTransitionModel, bpp::AbstractTransitionModel, bpp::AbstractTotallyWrappedTransitionModel, bpp::G2001, bpp::InMixedSubstitutionModel, bpp::MarkovModulatedSubstitutionModel, bpp::MultinomialFromTransitionModel, bpp::OneChangeRegisterTransitionModel, bpp::OneChangeTransitionModel, bpp::RegisterRatesSubstitutionModel, bpp::TransitionFromTransitionModel, and bpp::TS98.
Referenced by bpp::AbstractBiblioTransitionModel::fireParameterChanged(), bpp::AbstractTotallyWrappedTransitionModel::setRate(), bpp::InMixedSubstitutionModel::setRate(), bpp::MultinomialFromTransitionModel::setRate(), bpp::OneChangeRegisterTransitionModel::setRate(), bpp::OneChangeTransitionModel::setRate(), bpp::RegisterRatesSubstitutionModel::setRate(), and bpp::TransitionFromTransitionModel::setRate().
|
inlineoverridevirtual |
Implements bpp::BranchModelInterface.
Reimplemented in bpp::RegisterRatesSubstitutionModel.
Definition at line 40 of file AbstractWrappedModel.h.
References bpp::WrappedModelInterface::model(), and bpp::BranchModelInterface::stateMap().
Referenced by bpp::RegisterRatesSubstitutionModel::stateMap().