bpp::BranchedModelSet Class Reference

#include <Bpp/Phyl/Mapping/BranchedModelSet.h>

Inheritance diagram for bpp::BranchedModelSet:

Public Member Functions
	BranchedModelSet ()
virtual	~BranchedModelSet ()
virtual size_t	getNumberOfModels () const =0
virtual std::vector< size_t >	getModelNumbers () const =0
virtual std::shared_ptr< const TransitionModelInterface >	getModel (size_t index) const =0
	Get the model with a ginev index. More...
virtual std::shared_ptr< const TransitionModelInterface >	getModelForBranch (unsigned int branchId) const =0
	Get the model associated to a particular branch id. More...
virtual std::shared_ptr< TransitionModelInterface >	getModelForBranch (unsigned int branchId)=0
virtual std::vector< unsigned int >	getBranchesWithModel (size_t index) const =0
	Get a list of branches id for which the given model is associated. More...

Detailed Description

Definition at line 21 of file BranchedModelSet.h.

Constructor & Destructor Documentation

BranchedModelSet()

bpp::BranchedModelSet::BranchedModelSet ( )

inline

Definition at line 24 of file BranchedModelSet.h.

~BranchedModelSet()

virtual bpp::BranchedModelSet::~BranchedModelSet ( )

inlinevirtual

Definition at line 25 of file BranchedModelSet.h.

Member Function Documentation

getBranchesWithModel()

virtual std::vector<unsigned int> bpp::BranchedModelSet::getBranchesWithModel ( size_t  index ) const

pure virtual

Get a list of branches id for which the given model is associated.

Parameters

index

The index of the model.

Returns

A vector with the ids of the branch associated to this model.

Implemented in bpp::AbstractSinglePhyloSubstitutionMapping.

getModel()

virtual std::shared_ptr<const TransitionModelInterface> bpp::BranchedModelSet::getModel ( size_t  index ) const

pure virtual

Get the model with a ginev index.

Parameters

index

The index of the query model.

Returns

A pointer toward the corresponding model.

Implemented in bpp::AbstractSinglePhyloSubstitutionMapping.

getModelForBranch() [1/2]

virtual std::shared_ptr<const TransitionModelInterface> bpp::BranchedModelSet::getModelForBranch ( unsigned int  branchId ) const

pure virtual

Get the model associated to a particular branch id.

Parameters

branchId

The id of the query branch.

Returns

A pointer toward the corresponding model.

Exceptions

Exception

If no model is found for this branch.

getModelForBranch() [2/2]

virtual std::shared_ptr<TransitionModelInterface> bpp::BranchedModelSet::getModelForBranch ( unsigned int  branchId )

pure virtual

getModelNumbers()

virtual std::vector<size_t> bpp::BranchedModelSet::getModelNumbers ( ) const

pure virtual

Returns

The vector of model indexes.

Implemented in bpp::OneProcessSequenceSubstitutionMapping, and bpp::SingleProcessSubstitutionMapping.

getNumberOfModels()

virtual size_t bpp::BranchedModelSet::getNumberOfModels ( ) const

pure virtual

Returns

The current number of distinct substitution models in this set.

Implemented in bpp::OneProcessSequenceSubstitutionMapping, and bpp::SingleProcessSubstitutionMapping.

---

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

• Bpp/Phyl/Mapping/BranchedModelSet.h