bpp-phyl  2.2.0
bpp::DRASDRTreeLikelihoodNodeData Class Reference

Likelihood data structure for a node. More...

#include <Bpp/Phyl/Likelihood/DRASDRTreeLikelihoodData.h>

+ Inheritance diagram for bpp::DRASDRTreeLikelihoodNodeData:
+ Collaboration diagram for bpp::DRASDRTreeLikelihoodNodeData:

Public Member Functions

 DRASDRTreeLikelihoodNodeData ()
 
 DRASDRTreeLikelihoodNodeData (const DRASDRTreeLikelihoodNodeData &data)
 
DRASDRTreeLikelihoodNodeDataoperator= (const DRASDRTreeLikelihoodNodeData &data)
 
virtual ~DRASDRTreeLikelihoodNodeData ()
 
DRASDRTreeLikelihoodNodeDataclone () const
 
const NodegetNode () const
 Get the node associated to this data structure. More...
 
void setNode (const Node *node)
 Set the node associated to this data. More...
 
const std::map< int, VVVdouble > & getLikelihoodArrays () const
 
std::map< int, VVVdouble > & getLikelihoodArrays ()
 
VVVdouble & getLikelihoodArrayForNeighbor (int neighborId)
 
const VVVdouble & getLikelihoodArrayForNeighbor (int neighborId) const
 
Vdouble & getDLikelihoodArray ()
 
const Vdouble & getDLikelihoodArray () const
 
Vdouble & getD2LikelihoodArray ()
 
const Vdouble & getD2LikelihoodArrayForNeighbor () const
 
bool isNeighbor (int neighborId) const
 
void eraseNeighborArrays ()
 

Private Attributes

std::map< int, VVVdouble > nodeLikelihoods_
 This contains all likelihood values used for computation. More...
 
Vdouble nodeDLikelihoods_
 This contains all likelihood first order derivatives values used for computation. More...
 
Vdouble nodeD2Likelihoods_
 This contains all likelihood second order derivatives values used for computation. More...
 
const Nodenode_
 

Detailed Description

Likelihood data structure for a node.

This class is for use with the DRASDRTreeLikelihoodData class.

Store for each neighbor node an array with conditionnal likelihoods.

See also
DRASDRTreeLikelihoodData

Definition at line 113 of file DRASDRTreeLikelihoodData.h.

Constructor & Destructor Documentation

◆ DRASDRTreeLikelihoodNodeData() [1/2]

bpp::DRASDRTreeLikelihoodNodeData::DRASDRTreeLikelihoodNodeData ( )
inline

Definition at line 156 of file DRASDRTreeLikelihoodData.h.

Referenced by clone().

◆ DRASDRTreeLikelihoodNodeData() [2/2]

bpp::DRASDRTreeLikelihoodNodeData::DRASDRTreeLikelihoodNodeData ( const DRASDRTreeLikelihoodNodeData data)
inline

Definition at line 158 of file DRASDRTreeLikelihoodData.h.

◆ ~DRASDRTreeLikelihoodNodeData()

virtual bpp::DRASDRTreeLikelihoodNodeData::~DRASDRTreeLikelihoodNodeData ( )
inlinevirtual

Definition at line 174 of file DRASDRTreeLikelihoodData.h.

Member Function Documentation

◆ clone()

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

◆ eraseNeighborArrays()

void bpp::DRASDRTreeLikelihoodNodeData::eraseNeighborArrays ( )
inline

◆ getD2LikelihoodArray()

Vdouble& bpp::DRASDRTreeLikelihoodNodeData::getD2LikelihoodArray ( )
inline

◆ getD2LikelihoodArrayForNeighbor()

const Vdouble& bpp::DRASDRTreeLikelihoodNodeData::getD2LikelihoodArrayForNeighbor ( ) const
inline

Definition at line 211 of file DRASDRTreeLikelihoodData.h.

References nodeD2Likelihoods_.

◆ getDLikelihoodArray() [1/2]

Vdouble& bpp::DRASDRTreeLikelihoodNodeData::getDLikelihoodArray ( )
inline

◆ getDLikelihoodArray() [2/2]

const Vdouble& bpp::DRASDRTreeLikelihoodNodeData::getDLikelihoodArray ( ) const
inline

Definition at line 207 of file DRASDRTreeLikelihoodData.h.

References nodeDLikelihoods_.

◆ getLikelihoodArrayForNeighbor() [1/2]

VVVdouble& bpp::DRASDRTreeLikelihoodNodeData::getLikelihoodArrayForNeighbor ( int  neighborId)
inline

◆ getLikelihoodArrayForNeighbor() [2/2]

const VVVdouble& bpp::DRASDRTreeLikelihoodNodeData::getLikelihoodArrayForNeighbor ( int  neighborId) const
inline

Definition at line 200 of file DRASDRTreeLikelihoodData.h.

References nodeLikelihoods_.

◆ getLikelihoodArrays() [1/2]

const std::map<int, VVVdouble>& bpp::DRASDRTreeLikelihoodNodeData::getLikelihoodArrays ( ) const
inline

◆ getLikelihoodArrays() [2/2]

std::map<int, VVVdouble>& bpp::DRASDRTreeLikelihoodNodeData::getLikelihoodArrays ( )
inline

Definition at line 193 of file DRASDRTreeLikelihoodData.h.

References nodeLikelihoods_.

◆ getNode()

const Node* bpp::DRASDRTreeLikelihoodNodeData::getNode ( ) const
inlinevirtual

Get the node associated to this data structure.

Returns
The node associated to this structure.

Implements bpp::TreeLikelihoodNodeData.

Definition at line 187 of file DRASDRTreeLikelihoodData.h.

References node_.

◆ isNeighbor()

bool bpp::DRASDRTreeLikelihoodNodeData::isNeighbor ( int  neighborId) const
inline

Definition at line 213 of file DRASDRTreeLikelihoodData.h.

References nodeLikelihoods_.

◆ operator=()

DRASDRTreeLikelihoodNodeData& bpp::DRASDRTreeLikelihoodNodeData::operator= ( const DRASDRTreeLikelihoodNodeData data)
inline

◆ setNode()

void bpp::DRASDRTreeLikelihoodNodeData::setNode ( const Node node)
inlinevirtual

Set the node associated to this data.

A pointer toward this node will be created and associated to this data.

Parameters
nodeThe node to be associated to this data.

Implements bpp::TreeLikelihoodNodeData.

Definition at line 189 of file DRASDRTreeLikelihoodData.h.

References node_.

Referenced by bpp::DRASDRTreeLikelihoodData::initLikelihoods(), and bpp::DRASDRTreeLikelihoodData::reInit().

Member Data Documentation

◆ node_

const Node* bpp::DRASDRTreeLikelihoodNodeData::node_
private

Definition at line 153 of file DRASDRTreeLikelihoodData.h.

Referenced by getNode(), operator=(), and setNode().

◆ nodeD2Likelihoods_

Vdouble bpp::DRASDRTreeLikelihoodNodeData::nodeD2Likelihoods_
mutableprivate

This contains all likelihood second order derivatives values used for computation.

x[i]
  |---------> Site i

We call this the d2Likelihood array for each node.

Definition at line 151 of file DRASDRTreeLikelihoodData.h.

Referenced by eraseNeighborArrays(), getD2LikelihoodArray(), getD2LikelihoodArrayForNeighbor(), and operator=().

◆ nodeDLikelihoods_

Vdouble bpp::DRASDRTreeLikelihoodNodeData::nodeDLikelihoods_
mutableprivate

This contains all likelihood first order derivatives values used for computation.

x[i]
  |---------> Site i

We call this the dLikelihood array for each node.

Definition at line 140 of file DRASDRTreeLikelihoodData.h.

Referenced by eraseNeighborArrays(), getDLikelihoodArray(), and operator=().

◆ nodeLikelihoods_

std::map<int, VVVdouble> bpp::DRASDRTreeLikelihoodNodeData::nodeLikelihoods_
mutableprivate

This contains all likelihood values used for computation.

x[b][i][c][s]
  |------------> Neighbor node of n (id)
     |---------> Site i
        |------> Rate class c
           |---> Ancestral state s

We call this the likelihood array for each node.

Definition at line 130 of file DRASDRTreeLikelihoodData.h.

Referenced by eraseNeighborArrays(), getLikelihoodArrayForNeighbor(), getLikelihoodArrays(), isNeighbor(), and operator=().


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