bpp-phyl3  3.0.0
Public Member Functions | Protected Attributes | Private Attributes | List of all members
bpp::TsTvSubstitutionRegister Class Reference

Distinguishes transitions from transversions. More...

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

+ Inheritance diagram for bpp::TsTvSubstitutionRegister:
+ Collaboration diagram for bpp::TsTvSubstitutionRegister:

Public Member Functions

 TsTvSubstitutionRegister (std::shared_ptr< const StateMapInterface > stateMap)
 
 TsTvSubstitutionRegister (std::shared_ptr< const StateMapInterface > stateMap, std::shared_ptr< const GeneticCode > genCode)
 
 TsTvSubstitutionRegister (const TsTvSubstitutionRegister &reg)
 
TsTvSubstitutionRegister & operator= (const TsTvSubstitutionRegister &reg)
 
TsTvSubstitutionRegister * clone () const
 
size_t getNumberOfSubstitutionTypes () const
 
size_t getType (size_t fromState, size_t toState) const
 Get the substitution type far a given pair of model states. More...
 
std::string getTypeName (size_t type) const
 Get the name of a given substitution type. More...
 
const StateMapInterface & stateMap () const override
 
std::shared_ptr< const StateMapInterface > getStateMap () const override
 
const Alphabet & alphabet () const override
 
std::shared_ptr< const Alphabet > getAlphabet () const override
 
const std::string & getName () const override
 Get the name of the register. More...
 

Protected Attributes

std::shared_ptr< const StateMapInterface > stateMap_
 
std::string name_
 

Private Attributes

std::shared_ptr< const GeneticCode > genCode_
 useful for codon alphabet More...
 

Detailed Description

Distinguishes transitions from transversions.

This register has two substitution types, mapped as:

  • 0 not a substitution
  • 1 a transition
  • 2 a transversion

Definition at line 740 of file SubstitutionRegister.h.

Constructor & Destructor Documentation

◆ TsTvSubstitutionRegister() [1/3]

bpp::TsTvSubstitutionRegister::TsTvSubstitutionRegister ( std::shared_ptr< const StateMapInterface >  stateMap)
inline

Definition at line 750 of file SubstitutionRegister.h.

Referenced by clone().

◆ TsTvSubstitutionRegister() [2/3]

bpp::TsTvSubstitutionRegister::TsTvSubstitutionRegister ( std::shared_ptr< const StateMapInterface >  stateMap,
std::shared_ptr< const GeneticCode >  genCode 
)
inline

Definition at line 755 of file SubstitutionRegister.h.

◆ TsTvSubstitutionRegister() [3/3]

bpp::TsTvSubstitutionRegister::TsTvSubstitutionRegister ( const TsTvSubstitutionRegister &  reg)
inline

Definition at line 760 of file SubstitutionRegister.h.

Member Function Documentation

◆ alphabet()

const Alphabet& bpp::AbstractSubstitutionRegister::alphabet ( ) const
inlineoverridevirtualinherited
Returns
The alphabet associated to this instance.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 133 of file SubstitutionRegister.h.

References bpp::AbstractSubstitutionRegister::stateMap_.

◆ clone()

TsTvSubstitutionRegister* bpp::TsTvSubstitutionRegister::clone ( ) const
inlinevirtual

Implements bpp::SubstitutionRegisterInterface.

Definition at line 772 of file SubstitutionRegister.h.

References TsTvSubstitutionRegister().

◆ getAlphabet()

std::shared_ptr<const Alphabet> bpp::AbstractSubstitutionRegister::getAlphabet ( ) const
inlineoverridevirtualinherited
Returns
A shared_ptr toward the alphabet associated to this instance.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 135 of file SubstitutionRegister.h.

References bpp::AbstractSubstitutionRegister::stateMap_.

◆ getName()

const std::string& bpp::AbstractSubstitutionRegister::getName ( ) const
inlineoverridevirtualinherited

Get the name of the register.

Returns
A string describing the register.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 137 of file SubstitutionRegister.h.

References bpp::AbstractSubstitutionRegister::name_.

◆ getNumberOfSubstitutionTypes()

size_t bpp::TsTvSubstitutionRegister::getNumberOfSubstitutionTypes ( ) const
inlinevirtual
Returns
The number of substitution types supported by this class.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 775 of file SubstitutionRegister.h.

◆ getStateMap()

std::shared_ptr<const StateMapInterface> bpp::AbstractSubstitutionRegister::getStateMap ( ) const
inlineoverridevirtualinherited
Returns
A shared_ptr toward the state map associated to this instance.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 131 of file SubstitutionRegister.h.

References bpp::AbstractSubstitutionRegister::stateMap_.

◆ getType()

size_t bpp::TsTvSubstitutionRegister::getType ( size_t  fromState,
size_t  toState 
) const
inlinevirtual

Get the substitution type far a given pair of model states.

Parameters
fromStateInitial state (should be a state supported by the specified alphabet).
toStateFinal state (should be a state supported by the specified alphabet).
Returns
The index of the corresponding substitution type, ranging from 0 to 'getNumberOfSubstitutionTypes' + 1, as non-substitution (that is when fromState == toState) will always return 0.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 777 of file SubstitutionRegister.h.

References bpp::abs(), genCode_, bpp::StateMapInterface::getAlphabetStateAsInt(), and bpp::AbstractSubstitutionRegister::stateMap().

◆ getTypeName()

std::string bpp::TsTvSubstitutionRegister::getTypeName ( size_t  type) const
inlinevirtual

Get the name of a given substitution type.

This method is only used for user-friendlyness purposes, not computational goal. I can therefore be left unimplemented in some cases.

Parameters
typeIndex of the substitution (should be an size_t contained in the register).
Returns
A string describing the substitution type.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 818 of file SubstitutionRegister.h.

◆ operator=()

TsTvSubstitutionRegister& bpp::TsTvSubstitutionRegister::operator= ( const TsTvSubstitutionRegister &  reg)
inline

Definition at line 765 of file SubstitutionRegister.h.

References genCode_, and bpp::AbstractSubstitutionRegister::operator=().

◆ stateMap()

const StateMapInterface& bpp::AbstractSubstitutionRegister::stateMap ( ) const
inlineoverridevirtualinherited
Returns
The state map associated to this instance.

Implements bpp::SubstitutionRegisterInterface.

Definition at line 129 of file SubstitutionRegister.h.

References bpp::AbstractSubstitutionRegister::stateMap_.

Referenced by bpp::VectorOfSubstitutionRegisters::addRegister(), bpp::ComprehensiveSubstitutionRegister::ComprehensiveSubstitutionRegister(), bpp::GCSynonymousSubstitutionRegister::getType(), bpp::GCPositionSubstitutionRegister::getType(), getType(), bpp::SWSubstitutionRegister::getType(), bpp::DnDsSubstitutionRegister::getType(), bpp::KrKcSubstitutionRegister::getType(), bpp::SelectedSubstitutionRegister::SelectedSubstitutionRegister(), bpp::CategorySubstitutionRegister::setAlphabetCategories(), bpp::CategorySubstitutionRegister::setModelCategories(), bpp::AAInteriorSubstitutionRegister::updateMatrix_(), and bpp::AAExteriorSubstitutionRegister::updateMatrix_().

Member Data Documentation

◆ genCode_

std::shared_ptr<const GeneticCode> bpp::TsTvSubstitutionRegister::genCode_
private

useful for codon alphabet

Definition at line 747 of file SubstitutionRegister.h.

Referenced by getType(), and operator=().

◆ name_

std::string bpp::AbstractSubstitutionRegister::name_
protectedinherited

Definition at line 108 of file SubstitutionRegister.h.

Referenced by bpp::AbstractSubstitutionRegister::getName(), and bpp::AbstractSubstitutionRegister::operator=().

◆ stateMap_

std::shared_ptr<const StateMapInterface> bpp::AbstractSubstitutionRegister::stateMap_
protectedinherited

Definition at line 107 of file SubstitutionRegister.h.

Referenced by bpp::AbstractSubstitutionRegister::alphabet(), bpp::AbstractSubstitutionRegister::getAlphabet(), bpp::AbstractSubstitutionRegister::getStateMap(), bpp::AbstractSubstitutionRegister::operator=(), and bpp::AbstractSubstitutionRegister::stateMap().

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