AbstractCodonSubstitutionModel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1
 
#ifndef BPP_PHYL_MODEL_CODON_ABSTRACTCODONSUBSTITUTIONMODEL_H
#define BPP_PHYL_MODEL_CODON_ABSTRACTCODONSUBSTITUTIONMODEL_H
 
 
#include "../AbstractWordSubstitutionModel.h"
#include "../Nucleotide/NucleotideSubstitutionModel.h"
#include "CodonSubstitutionModel.h"
 
// From bpp-seq:
#include <Bpp/Seq/GeneticCode/GeneticCode.h>
 
// From the STL:
#include <memory>
 
namespace bpp
{
class AbstractCodonSubstitutionModel :
  public virtual CodonSubstitutionModelInterface,
  public AbstractWordSubstitutionModel
{
private:
  bool hasParametrizedRates_;
  std::shared_ptr<const GeneticCode> gCode_;
 
public:
  AbstractCodonSubstitutionModel(
      std::shared_ptr<const GeneticCode> gCode,
      std::unique_ptr<NucleotideSubstitutionModelInterface> pmod,
      const std::string& st,
      bool paramRates = false);
 
  AbstractCodonSubstitutionModel(
      std::shared_ptr<const GeneticCode> gCode,
      std::unique_ptr<NucleotideSubstitutionModelInterface> pmod1,
      std::unique_ptr<NucleotideSubstitutionModelInterface> pmod2,
      std::unique_ptr<NucleotideSubstitutionModelInterface> pmod3,
      const std::string& st,
      bool paramRates = false);
 
  virtual ~AbstractCodonSubstitutionModel() {}
 
  AbstractCodonSubstitutionModel(const AbstractCodonSubstitutionModel& model) :
    AbstractWordSubstitutionModel(model),
    hasParametrizedRates_(model.hasParametrizedRates_),
    gCode_(model.gCode_)
  {}
 
  AbstractCodonSubstitutionModel& operator=(const AbstractCodonSubstitutionModel& model)
  {
    AbstractWordSubstitutionModel::operator=(model);
    hasParametrizedRates_ = model.hasParametrizedRates_;
    gCode_ = model.gCode_;
    return *this;
  }
 
  AbstractCodonSubstitutionModel* clone() const override = 0;
 
  void setNamespace(const std::string& prefix) override
  {
    AbstractWordSubstitutionModel::setNamespace(prefix);
  }
 
protected:
  void completeMatrices_() override;
 
  void updateMatrices_() override;
 
public:
  std::shared_ptr<const GeneticCode> getGeneticCode() const override { return gCode_; }
};
} // end of namespace bpp.
#endif // BPP_PHYL_MODEL_CODON_ABSTRACTCODONSUBSTITUTIONMODEL_H