bpp-phyl  2.2.0
LLG08_EX2.h
Go to the documentation of this file.
1 //
2 // File: LLG08_EX2.h
3 // Created by: Laurent Gueguen
4 // Created on: mardi 12 octobre 2010, à 09h 42
5 //
6 
7 /*
8  Copyright or © or Copr. CNRS, (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 #ifndef _LLG08_EX2_H_
41 #define _LLG08_EX2_H_
42 
43 #include "../MixtureOfSubstitutionModels.h"
45 #include "../AbstractSubstitutionModel.h"
46 #include "../AbstractBiblioMixedSubstitutionModel.h"
47 
48 using namespace std;
49 
50 namespace bpp
51 {
74 class LLG08_EX2 :
76 {
77 public:
78  class EmbeddedModel :
79  public virtual ProteinSubstitutionModel,
81  {
82 private:
83  double proportion_;
84  string name_;
85 
86 public:
87  EmbeddedModel(const ProteicAlphabet* alpha, string name);
89  EmbeddedModel* clone() const { return new EmbeddedModel(*this); }
90  string getName() const { return name_;}
91  double getProportion() const { return proportion_;}
92  };
93 
94 private:
95  std::auto_ptr<MixtureOfSubstitutionModels> pmixmodel_;
96 
97 public:
105  LLG08_EX2(const ProteicAlphabet* alpha);
106 
107  ~LLG08_EX2();
108 
109  LLG08_EX2* clone() const { return new LLG08_EX2(*this); }
110 
111  LLG08_EX2(const LLG08_EX2&);
112 
113  LLG08_EX2& operator=(const LLG08_EX2&);
114 
115  const SubstitutionModel& getModel() const { return *pmixmodel_.get(); }
116 
117  const MixedSubstitutionModel& getMixedModel() const { return *pmixmodel_.get(); }
118 
119  std::string getName() const { return "LLG08_EX2"; }
120 
121 private:
122  SubstitutionModel& getModel() { return *pmixmodel_.get(); }
123 
124  MixedSubstitutionModel& getMixedModel() { return *pmixmodel_.get(); }
125 
126 };
127 } // end of namespace bpp.
128 
129 #endif // _LLG08_EX2_H_
130 
Interface for all substitution models.
Abstract class for mixture models based on the bibliography.
string getName() const
Get the name of the model.
Definition: LLG08_EX2.h:90
const MixedSubstitutionModel & getMixedModel() const
Definition: LLG08_EX2.h:117
Specialized interface for protein substitution model.
STL namespace.
const SubstitutionModel & getModel() const
Definition: LLG08_EX2.h:115
The Le et al (2008) EX2 substitution model for proteins.
Definition: LLG08_EX2.h:74
EmbeddedModel * clone() const
Definition: LLG08_EX2.h:89
MixedSubstitutionModel & getMixedModel()
Definition: LLG08_EX2.h:124
Partial implementation of the ReversibleSubstitutionModel interface.
LLG08_EX2 * clone() const
Definition: LLG08_EX2.h:109
double getProportion() const
Definition: LLG08_EX2.h:91
SubstitutionModel & getModel()
Definition: LLG08_EX2.h:122
std::string getName() const
Get the name of the model.
Definition: LLG08_EX2.h:119
std::auto_ptr< MixtureOfSubstitutionModels > pmixmodel_
Definition: LLG08_EX2.h:95
Interface for Substitution models, defined as a mixture of "simple" substitution models.