bpp-phyl  2.2.0
SitePartitionTreeLikelihood.h
Go to the documentation of this file.
1 //
2 // File: SitePartitionTreeLikelihood.h
3 // Created by: Julien Dutheil
4 // Created on: Mon Dec 7 11:02 2009
5 //
6 
7 /*
8 Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
9 
10 This software is a computer program whose purpose is to provide classes
11 for phylogenetic data analysis.
12 
13 This software is governed by the CeCILL license under French law and
14 abiding by the rules of distribution of free software. You can use,
15 modify and/ or redistribute the software under the terms of the CeCILL
16 license as circulated by CEA, CNRS and INRIA at the following URL
17 "http://www.cecill.info".
18 
19 As a counterpart to the access to the source code and rights to copy,
20 modify and redistribute granted by the license, users are provided only
21 with a limited warranty and the software's author, the holder of the
22 economic rights, and the successive licensors have only limited
23 liability.
24 
25 In this respect, the user's attention is drawn to the risks associated
26 with loading, using, modifying and/or developing or reproducing the
27 software by the user in light of its specific status of free software,
28 that may mean that it is complicated to manipulate, and that also
29 therefore means that it is reserved for developers and experienced
30 professionals having in-depth computer knowledge. Users are therefore
31 encouraged to load and test the software's suitability as regards their
32 requirements in conditions enabling the security of their systems and/or
33 data to be ensured and, more generally, to use and operate it in the
34 same conditions as regards security.
35 
36 The fact that you are presently reading this means that you have had
37 knowledge of the CeCILL license and that you accept its terms.
38 */
39 
40 
41 #ifndef _SITEPARTITIONTREELIKELIHOOD_H_
42 #define _SITEPARTITIONTREELIKELIHOOD_H_
43 
44 #include "TreeLikelihood.h"
45 
46 namespace bpp
47 {
48 
57  public virtual TreeLikelihood
58 {
59  public:
60 #ifndef NO_VIRTUAL_COV
62 #endif
63 
64  public:
65  const SubstitutionModel* getSubstitutionModel(int nodeId, size_t siteIndex) const throw (NodeNotFoundException)
66  {
67  return getSubstitutionModelForSite(siteIndex);
68  }
69 
70  SubstitutionModel* getSubstitutionModel(int nodeId, size_t siteIndex) throw (NodeNotFoundException)
71  {
72  return getSubstitutionModelForSite(siteIndex);
73  }
74 
81  virtual const SubstitutionModel* getSubstitutionModelForSite(size_t siteIndex) const = 0;
82 
89  virtual SubstitutionModel* getSubstitutionModelForSite(size_t siteIndex) = 0;
90 
91 };
92 
93 } //end of namespace bpp.
94 
95 #endif //_SITEPARTITIONTREELIKELIHOOD_H_
96 
Interface for all substitution models.
const SubstitutionModel * getSubstitutionModel(int nodeId, size_t siteIndex) const
Get the substitution model associated to a given node and alignment column.
SubstitutionModel * getSubstitutionModel(int nodeId, size_t siteIndex)
Get the substitution model associated to a given node and alignment column.
The TreeLikelihood interface.
SitePartitionHomogeneousTreeLikelihood * clone() const =0
virtual const SubstitutionModel * getSubstitutionModelForSite(size_t siteIndex) const =0
Get the substitution model associated to a given node.
Exception thrown when something is wrong with a particular node.
Specialization of the TreeLikelihood interface for partition models, homogeneous case.