bpp::MappingInterface Class Reference

General interface for storing mapping data. More...

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

Inheritance diagram for bpp::MappingInterface:

Collaboration diagram for bpp::MappingInterface:

Public Member Functions
	MappingInterface ()
virtual	~MappingInterface ()
MappingInterface *	clone () const override=0
virtual size_t	getNumberOfSites () const =0
virtual const PhyloBranch &	getBranch (unsigned int branchId) const =0
virtual PhyloBranch &	getBranch (unsigned int branchId)=0
virtual size_t	getNumberOfBranches () const =0
virtual int	getSitePosition (size_t index) const =0
virtual void	setSitePosition (size_t index, int position)=0
	Set the position of a given site. More...

Detailed Description

General interface for storing mapping data.

Definition at line 24 of file Mapping.h.

Constructor & Destructor Documentation

MappingInterface()

bpp::MappingInterface::MappingInterface ( )

inline

Definition at line 28 of file Mapping.h.

~MappingInterface()

virtual bpp::MappingInterface::~MappingInterface ( )

inlinevirtual

Definition at line 29 of file Mapping.h.

Member Function Documentation

clone()

MappingInterface * bpp::MappingInterface::clone ( ) const

overridepure virtual

Implements bpp::Clonable.

Implemented in bpp::AbstractSubstitutionMapping, bpp::ProbabilisticRewardMapping, bpp::ProbabilisticSubstitutionMapping, bpp::RewardMappingInterface, bpp::AbstractRewardMapping, and bpp::SubstitutionMapping.

getBranch() [1/2]

virtual const PhyloBranch & bpp::MappingInterface::getBranch ( unsigned int  branchId ) const

pure virtual

Returns

The PhyloBranchMapping to a given index

Implemented in bpp::ProbabilisticRewardMapping, and bpp::ProbabilisticSubstitutionMapping.

getBranch() [2/2]

virtual PhyloBranch & bpp::MappingInterface::getBranch ( unsigned int  branchId )

pure virtual

Implemented in bpp::ProbabilisticRewardMapping, and bpp::ProbabilisticSubstitutionMapping.

getNumberOfBranches()

virtual size_t bpp::MappingInterface::getNumberOfBranches ( ) const

pure virtual

Returns

The number of branches mapped.

Implemented in bpp::ProbabilisticRewardMapping, and bpp::ProbabilisticSubstitutionMapping.

getNumberOfSites()

virtual size_t bpp::MappingInterface::getNumberOfSites ( ) const

pure virtual

Returns

The number of sites mapped.

Implemented in bpp::AbstractMapping.

getSitePosition()

virtual int bpp::MappingInterface::getSitePosition ( size_t  index ) const

pure virtual

Parameters

index

The site index.

Returns

The site position corresponding to the index.

Implemented in bpp::AbstractMapping.

setSitePosition()

virtual void bpp::MappingInterface::setSitePosition ( size_t  index, int  position  )

pure virtual

Set the position of a given site.

Warning

No index checking is performed, use with care!

Parameters

index	The site index.
position	The position of the site.

Implemented in bpp::AbstractMapping.

---

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

• Bpp/Phyl/Mapping/Mapping.h