LogsumHmmLikelihood.h

Go to the documentation of this file.

//
// File: LogsumHmmLikelihood.h
// Authors:
//   Julien Dutheil
// Created: 2009-11-23 11:27:00
//
 
/*
  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 BPP_NUMERIC_HMM_LOGSUMHMMLIKELIHOOD_H
#define BPP_NUMERIC_HMM_LOGSUMHMMLIKELIHOOD_H
 
 
#include "../AbstractParametrizable.h"
#include "../Matrix/Matrix.h"
#include "../NumTools.h"
#include "HmmLikelihood.h"
 
// From the STL:
#include <vector>
#include <memory>
 
namespace bpp
{
class LogsumHmmLikelihood :
  public virtual AbstractHmmLikelihood,
  public AbstractParametrizable
{
protected:
  HmmStateAlphabet* hiddenAlphabet_;
  HmmTransitionMatrix* transitionMatrix_;
  HmmEmissionProbabilities* emissionProbabilities_;
 
  bool ownsPointers_;
 
  std::vector<double> logLikelihood_;
  std::vector<double> partialLogLikelihoods_;
  double logLik_;
 
  mutable std::vector< std::vector<double> > dLogLikelihood_;
  mutable std::vector<double> partialDLogLikelihoods_;
 
  mutable std::vector< std::vector<double> > d2LogLikelihood_;
  mutable std::vector<double> partialD2LogLikelihoods_;
 
  mutable std::vector<std::vector<double> > backLogLikelihood_;
  mutable bool backLogLikelihoodUpToDate_;
 
  std::vector<size_t> breakPoints_;
 
  size_t nbStates_, nbSites_;
 
public:
  LogsumHmmLikelihood(
    HmmStateAlphabet* hiddenAlphabet,
    HmmTransitionMatrix* transitionMatrix,
    HmmEmissionProbabilities* emissionProbabilities,
    bool ownsPointers_ = true,
    const std::string& prefix = "");
 
  LogsumHmmLikelihood(const LogsumHmmLikelihood& lik) :
    AbstractHmmLikelihood(lik),
    AbstractParametrizable(lik),
    hiddenAlphabet_(),
    transitionMatrix_(),
    emissionProbabilities_(),
    ownsPointers_(lik.ownsPointers_),
    logLikelihood_(lik.logLikelihood_),
    partialLogLikelihoods_(lik.partialLogLikelihoods_),
    logLik_(lik.logLik_),
    dLogLikelihood_(lik.dLogLikelihood_),
    partialDLogLikelihoods_(lik.partialDLogLikelihoods_),
    d2LogLikelihood_(lik.d2LogLikelihood_),
    partialD2LogLikelihoods_(lik.partialD2LogLikelihoods_),
    backLogLikelihood_(lik.backLogLikelihood_),
    backLogLikelihoodUpToDate_(lik.backLogLikelihoodUpToDate_),
    breakPoints_(lik.breakPoints_),
    nbStates_(lik.nbStates_),
    nbSites_(lik.nbSites_)
  {
    if (ownsPointers_)
    {
      hiddenAlphabet_ = dynamic_cast<HmmStateAlphabet*>(lik.hiddenAlphabet_->clone());
      transitionMatrix_ = dynamic_cast<HmmTransitionMatrix*>(lik.transitionMatrix_->clone());
      emissionProbabilities_ = dynamic_cast<HmmEmissionProbabilities*>(lik.emissionProbabilities_->clone());
    }
    else
    {
      hiddenAlphabet_ = lik.hiddenAlphabet_;
      transitionMatrix_ = lik.transitionMatrix_;
      emissionProbabilities_ = lik.emissionProbabilities_;
    }
 
    // Now adjust pointers:
    transitionMatrix_->setHmmStateAlphabet(hiddenAlphabet_);
    emissionProbabilities_->setHmmStateAlphabet(hiddenAlphabet_);
  }
 
  LogsumHmmLikelihood& operator=(const LogsumHmmLikelihood& lik)
  {
    AbstractHmmLikelihood::operator=(lik);
    AbstractParametrizable::operator=(lik);
 
    ownsPointers_ = lik.ownsPointers_;
 
    if (ownsPointers_)
    {
      hiddenAlphabet_        = dynamic_cast<HmmStateAlphabet*>(lik.hiddenAlphabet_->clone());
      transitionMatrix_      = dynamic_cast<HmmTransitionMatrix*>(lik.transitionMatrix_->clone());
      emissionProbabilities_ = dynamic_cast<HmmEmissionProbabilities*>(lik.emissionProbabilities_->clone());
    }
    else
    {
      hiddenAlphabet_ = lik.hiddenAlphabet_;
      transitionMatrix_ = lik.transitionMatrix_;
      emissionProbabilities_ = lik.emissionProbabilities_;
    }
 
    logLikelihood_         = lik.logLikelihood_;
    partialLogLikelihoods_ = lik.partialLogLikelihoods_;
    dLogLikelihood_        = lik.dLogLikelihood_;
    partialDLogLikelihoods_ = lik.partialDLogLikelihoods_;
    d2LogLikelihood_       = lik.d2LogLikelihood_;
    partialD2LogLikelihoods_  = lik.partialD2LogLikelihoods_;
    backLogLikelihood_     = lik.backLogLikelihood_;
    backLogLikelihoodUpToDate_ = lik.backLogLikelihoodUpToDate_;
    logLik_                = lik.logLik_;
    breakPoints_           = lik.breakPoints_;
    nbStates_              = lik.nbStates_;
    nbSites_               = lik.nbSites_;
 
    // Now adjust pointers:
    transitionMatrix_->setHmmStateAlphabet(hiddenAlphabet_);
    emissionProbabilities_->setHmmStateAlphabet(hiddenAlphabet_);
    return *this;
  }
 
  virtual ~LogsumHmmLikelihood()
  {
    if (ownsPointers_)
    {
      delete hiddenAlphabet_;
      delete transitionMatrix_;
      delete emissionProbabilities_;
    }
  }
 
 
  LogsumHmmLikelihood* clone() const { return new LogsumHmmLikelihood(*this); }
 
public:
  const HmmStateAlphabet& getHmmStateAlphabet() const { return *hiddenAlphabet_; }
  HmmStateAlphabet& getHmmStateAlphabet() { return *hiddenAlphabet_; }
 
  const HmmTransitionMatrix& getHmmTransitionMatrix() const { return *transitionMatrix_; }
  HmmTransitionMatrix& getHmmTransitionMatrix() { return *transitionMatrix_; }
 
  const HmmEmissionProbabilities& getHmmEmissionProbabilities() const { return *emissionProbabilities_; }
  HmmEmissionProbabilities& getHmmEmissionProbabilities() { return *emissionProbabilities_; }
 
  void setBreakPoints(const std::vector<size_t>& breakPoints)
  {
    breakPoints_ = breakPoints;
    computeForward_();
    backLogLikelihoodUpToDate_ = false;
  }
 
  const std::vector<size_t>& getBreakPoints() const { return breakPoints_; }
 
  void setParameters(const ParameterList& pl)
  {
    setParametersValues(pl);
  }
 
  double getValue() const { return -logLik_; }
 
  double getLogLikelihood() const { return logLik_; }
 
  double getLikelihoodForASite(size_t site) const;
 
  double getDLogLikelihoodForASite(size_t site) const;
 
  double getD2LogLikelihoodForASite(size_t site) const;
 
  Vdouble getLikelihoodForEachSite() const;
 
  void setNamespace(const std::string& nameSpace);
 
  void fireParameterChanged(const ParameterList& pl);
 
  Vdouble getHiddenStatesPosteriorProbabilitiesForASite(size_t site) const;
 
  void getHiddenStatesPosteriorProbabilities(std::vector< std::vector<double> >& probs, bool append = false) const;
 
  void computeLikelihood();
 
protected:
  void computeForward_();
 
  void computeBackward_() const;
 
  void computeDLikelihood_() const
  {
    computeDForward_();
  }
 
  void computeD2Likelihood_() const
  {
    computeD2Forward_();
  }
 
  void computeDForward_() const;
 
  void computeD2Forward_() const;
};
}
#endif // BPP_NUMERIC_HMM_LOGSUMHMMLIKELIHOOD_H