bpp-core3  3.0.0
FullHmmTransitionMatrix.h
Go to the documentation of this file.
1 //
2 // File: FullHmmTransitionMatrix.h
3 // Authors:
4 // Laurent Guéguen
5 // Created: samedi 21 septembre 2013, à 00h 41
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++Development Team, (November 16, 2004)
10 
11  This software is a computer program whose purpose is to provide classes
12  for phylogenetic data analysis.
13 
14  This software is governed by the CeCILL license under French law and
15  abiding by the rules of distribution of free software. You can use,
16  modify and/ or redistribute the software under the terms of the CeCILL
17  license as circulated by CEA, CNRS and INRIA at the following URL
18  "http://www.cecill.info".
19 
20  As a counterpart to the access to the source code and rights to copy,
21  modify and redistribute granted by the license, users are provided only
22  with a limited warranty and the software's author, the holder of the
23  economic rights, and the successive licensors have only limited
24  liability.
25 
26  In this respect, the user's attention is drawn to the risks associated
27  with loading, using, modifying and/or developing or reproducing the
28  software by the user in light of its specific status of free software,
29  that may mean that it is complicated to manipulate, and that also
30  therefore means that it is reserved for developers and experienced
31  professionals having in-depth computer knowledge. Users are therefore
32  encouraged to load and test the software's suitability as regards their
33  requirements in conditions enabling the security of their systems and/or
34  data to be ensured and, more generally, to use and operate it in the
35  same conditions as regards security.
36 
37  The fact that you are presently reading this means that you have had
38  knowledge of the CeCILL license and that you accept its terms.
39 */
40 
41 #ifndef BPP_NUMERIC_HMM_FULLHMMTRANSITIONMATRIX_H
42 #define BPP_NUMERIC_HMM_FULLHMMTRANSITIONMATRIX_H
43 
44 
45 #include "../AbstractParameterAliasable.h"
46 #include "../Prob/Simplex.h"
48 
49 namespace bpp
50 {
66  public virtual AbstractHmmTransitionMatrix,
68 {
69 private:
70  std::vector<Simplex> vSimplex_;
71 
72 public:
73  FullHmmTransitionMatrix(const HmmStateAlphabet* alph, const std::string& prefix = "");
74 
76 
78 
79  FullHmmTransitionMatrix* clone() const { return new FullHmmTransitionMatrix(*this);}
80 
87 
95  double Pij(size_t i, size_t j) const
96  {
97  return vSimplex_[i].prob(j);
98  }
99 
106  const Matrix<double>& getPij() const;
107 
112  const std::vector<double>& getEquilibriumFrequencies() const;
113 
114 
115  /*
116  * @brief From AbstractParametrizable interface
117  *
118  */
119 
120  void fireParameterChanged(const ParameterList& parameters);
121 };
122 } // end of namespace bpp
123 #endif // BPP_NUMERIC_HMM_FULLHMMTRANSITIONMATRIX_H
Partial implementation of HmmTransitionMatrix.
A partial implementation of the Parametrizable interface.
Describe the transition probabilities between hidden states of a Hidden Markov Model.
const std::vector< double > & getEquilibriumFrequencies() const
FullHmmTransitionMatrix(const HmmStateAlphabet *alph, const std::string &prefix="")
void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
FullHmmTransitionMatrix & operator=(const FullHmmTransitionMatrix &hptm)
void setTransitionProbabilities(const Matrix< double > &mat)
Set the matrix of the transition probabilities.
double Pij(size_t i, size_t j) const
Get the transition probability between two states.
const Matrix< double > & getPij() const
Get all transition probabilities as a matrix.
FullHmmTransitionMatrix * clone() const
Create a copy of this object and send a pointer to it.
Hidden states alphabet.
The matrix template interface.
Definition: Matrix.h:61
The parameter list object.
Definition: ParameterList.h:65