2
// File: TripletSubstitutionModel.h
3
// Created by: Laurent Gueguen
4
// Created on: Tue Dec 24 11:03:53 2003
8
Copyright or © or Copr. CNRS, (November 16, 2004)
10
This software is a computer program whose purpose is to provide classes
11
for phylogenetic data analysis.
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".
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
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.
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.
40
#ifndef _TRIPLETSUBSTITUTIONMODEL_H_
41
#define _TRIPLETSUBSTITUTIONMODEL_H_
43
#include "WordSubstitutionModel.h"
44
#include "NucleotideSubstitutionModel.h"
47
#include <Bpp/Seq/Alphabet/CodonAlphabet.h>
53
* @brief Class for neutral substitution models on triplets,
54
* which correspond to codons that do not have any significance
55
* (whether they are STOP or functional).
56
* @author Laurent Guéguen
58
* Objects of this class are built from three substitution
59
* models of NucleicAlphabets. No model is directly accessible. </p>
63
class TripletSubstitutionModel :
64
public WordSubstitutionModel
69
*@brief Build a new TripletSubstitutionModel object from
70
*a pointer to a NucleotideSubstitutionModel.
72
*@param palph pointer to a CodonAlphabet
73
*@param pmod pointer to the NucleotideSubstitutionModel to be used
74
* in the three positions. It is owned by the instance.
77
TripletSubstitutionModel(const CodonAlphabet* palph,
78
NucleotideSubstitutionModel* pmod);
81
*@brief Build a new TripletSubstitutionModel object
82
*from three pointers to NucleotideSubstitutionModels.
84
*@param palph pointer to a CodonAlphabet
85
*@param pmod1, pmod2, pmod3 pointers to the
86
* NucleotideSubstitutionModels to use in the three positions. All
87
* the models must be different objects to avoid parameters
88
* redundancy, otherwise only the first model is used. The used
89
* models are owned by the instance.
92
TripletSubstitutionModel(const CodonAlphabet* palph,
93
NucleotideSubstitutionModel* pmod1,
94
NucleotideSubstitutionModel* pmod2,
95
NucleotideSubstitutionModel* pmod3);
97
~TripletSubstitutionModel() {};
99
#ifndef NO_VIRTUAL_COV
100
TripletSubstitutionModel*
104
clone() const { return new TripletSubstitutionModel(*this);}
107
std::string getName() const;
110
} //end of namespace bpp.
added
removed
src/Bpp/Phyl/Model/TripletSubstitutionModel.h
