/usr/include/Bpp/Phyl/Model/Codon/CodonDistanceSubstitutionModel.h is in libbpp-phyl-dev 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | //
// File: CodonDistanceSubstitutionModel.h
// Created by: Laurent Gueguen
// Created on: Tue Dec 24 11:03:53 2003
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 16, 2004)
This software is a computer program whose purpose is to provide classes
for phylogenetic data analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _CODONDISTANCESUBSTITUTIONMODEL_H_
#define _CODONDISTANCESUBSTITUTIONMODEL_H_
#include "AbstractCodonDistanceSubstitutionModel.h"
#include "AbstractCodonSubstitutionModel.h"
namespace bpp
{
/**
* @brief Class for substitution models of codons with
* non-synonymous/synonymous ratios of substitution rates defined
* through a distance between amino-acids.
*
* @author Laurent Guéguen
*
* Objects of this class are built from three substitution models of
* NucleicAlphabets. No model is directly accessible. </p>
*
* Only substitutions with one letter changed are accepted. </p>
*
* If a distance @f$d@f$ between amino-acids is defined, the ratio between
* non-synonymous and synonymous substitutions rates is, if the codied
* amino-acids are @f$x@f$ and @f$y@f$, @f$\beta*\exp(-\alpha.d(x,y))@f$ with
* non-negative parameter \c "alpha" and positive parameter \c "beta".
*
* If such a distance is not defined, the ratio between non-synonymous
* and synonymous substitutions rates is @f$\beta@f$ with positive
* parameter \c "beta".
*
*/
class CodonDistanceSubstitutionModel :
public AbstractCodonSubstitutionModel,
public AbstractCodonDistanceSubstitutionModel
{
public:
/**
* @brief Build a new CodonDistanceSubstitutionModel object from
* a pointer to NucleotideSubstitutionModel.
*
* @param palph pointer to a GeneticCode
* @param pmod pointer to the NucleotideSubstitutionModel to use in the three positions.
* The instance will then own this substitution model.
* @param pdist optional pointer to a distance between amino-acids
*/
CodonDistanceSubstitutionModel(const GeneticCode* palph,
NucleotideSubstitutionModel* pmod,
const AlphabetIndex2* pdist);
/**
* @brief Build a new CodonDistanceSubstitutionModel object
* from three pointers to NucleotideSubstitutionModels.
*
* @param palph pointer to a GeneticCode
* @param pmod1, pmod2, pmod3 pointers to the
* NucleotideSubstitutionModels to use in the three positions.
* Either all the models are different objects to avoid parameters
* redondancy, or only the first model is used in every position.
* The used models are owned by the instance.
* @param pdist optional pointer to the AlphabetIndex2 amino-acids distance object.
*/
CodonDistanceSubstitutionModel(const GeneticCode* palph,
NucleotideSubstitutionModel* pmod1,
NucleotideSubstitutionModel* pmod2,
NucleotideSubstitutionModel* pmod3,
const AlphabetIndex2* pdist);
CodonDistanceSubstitutionModel(const CodonDistanceSubstitutionModel& model) :
AbstractParameterAliasable(model),
AbstractSubstitutionModel(model),
AbstractWordSubstitutionModel(model),
AbstractCodonSubstitutionModel(model),
AbstractCodonDistanceSubstitutionModel(model)
{}
CodonDistanceSubstitutionModel & operator=(const CodonDistanceSubstitutionModel& model)
{
AbstractParameterAliasable::operator=(model);
AbstractSubstitutionModel::operator=(model);
AbstractWordSubstitutionModel::operator=(model);
AbstractCodonSubstitutionModel::operator=(model);
AbstractCodonDistanceSubstitutionModel::operator=(model);
return *this;
}
~CodonDistanceSubstitutionModel() {}
CodonDistanceSubstitutionModel* clone() const
{
return new CodonDistanceSubstitutionModel(*this);
}
public:
void fireParameterChanged(const ParameterList& parameterlist);
std::string getName() const;
double getCodonsMulRate(size_t i, size_t j) const;
};
} // end of namespace bpp.
#endif
|