bpp-phyl  2.2.0
bpp::TreeParsimonyScore Class Referenceabstract

Compute a parsimony score. More...

#include <Bpp/Phyl/Parsimony/TreeParsimonyScore.h>

+ Inheritance diagram for bpp::TreeParsimonyScore:
+ Collaboration diagram for bpp::TreeParsimonyScore:

Public Member Functions

 TreeParsimonyScore ()
 
virtual ~TreeParsimonyScore ()
 
TreeParsimonyScoreclone () const =0
 
virtual unsigned int getScore () const =0
 Get the score for the current tree, i.e. the total minimum number of changes in the tree. More...
 
virtual unsigned int getScoreForSite (size_t site) const =0
 Get the score for a given site for the current tree, i.e. the total minimum number of changes in the tree for this site. More...
 
virtual std::vector< unsigned int > getScoreForEachSite () const =0
 Get the score for each site for the current tree, i.e. the total minimum number of changes in the tree for each site. More...
 
virtual const TreegetTree () const =0
 Get the tree for wich scores are computed. More...
 

Detailed Description

Compute a parsimony score.

Definition at line 55 of file TreeParsimonyScore.h.

Constructor & Destructor Documentation

◆ TreeParsimonyScore()

bpp::TreeParsimonyScore::TreeParsimonyScore ( )
inline

Definition at line 59 of file TreeParsimonyScore.h.

◆ ~TreeParsimonyScore()

virtual bpp::TreeParsimonyScore::~TreeParsimonyScore ( )
inlinevirtual

Definition at line 60 of file TreeParsimonyScore.h.

Member Function Documentation

◆ clone()

TreeParsimonyScore* bpp::TreeParsimonyScore::clone ( ) const
pure virtual

Implemented in bpp::DRTreeParsimonyScore.

◆ getScore()

virtual unsigned int bpp::TreeParsimonyScore::getScore ( ) const
pure virtual

Get the score for the current tree, i.e. the total minimum number of changes in the tree.

Returns
The minimum total number of changes in the tree.

Implemented in bpp::DRTreeParsimonyScore.

◆ getScoreForEachSite()

virtual std::vector<unsigned int> bpp::TreeParsimonyScore::getScoreForEachSite ( ) const
pure virtual

Get the score for each site for the current tree, i.e. the total minimum number of changes in the tree for each site.

Returns
The minimum total number of changes in the tree for each site.

Implemented in bpp::AbstractTreeParsimonyScore.

◆ getScoreForSite()

virtual unsigned int bpp::TreeParsimonyScore::getScoreForSite ( size_t  site) const
pure virtual

Get the score for a given site for the current tree, i.e. the total minimum number of changes in the tree for this site.

Parameters
siteThe corresponding site.
Returns
The minimum total number of changes in the tree for site 'site'.

Implemented in bpp::DRTreeParsimonyScore.

◆ getTree()

virtual const Tree& bpp::TreeParsimonyScore::getTree ( ) const
pure virtual

Get the tree for wich scores are computed.

Returns
The tree associated to this object.

Implemented in bpp::AbstractTreeParsimonyScore.


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