bpp-core3  3.0.0
DirichletDiscreteDistribution.h
Go to the documentation of this file.
1 //
2 // File: DirichletDiscreteDistribution.h
3 // Authors:
4 // Laurent Guéguen
5 // Created: jeudi 2 septembre 2010, à 17h 03
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Team, (November 19, 2004)
10 
11  This software is a computer program whose purpose is to provide classes
12  for numerical calculus.
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_PROB_DIRICHLETDISCRETEDISTRIBUTION_H
42 #define BPP_NUMERIC_PROB_DIRICHLETDISCRETEDISTRIBUTION_H
43 
44 
45 #include "../../Exceptions.h"
46 #include "../../Io/OutputStream.h"
47 #include "../ParameterAliasable.h"
48 #include "../VectorTools.h"
51 
52 namespace bpp
53 {
106 {
107 private:
108  std::vector<BetaDiscreteDistribution* > vpBDD_;
109 
110 public:
117  DirichletDiscreteDistribution(std::vector<size_t> vn, Vdouble valpha);
118 
120 
122  {
123  return new DirichletDiscreteDistribution(*this);
124  }
125 
126 protected:
127  void applyParameters();
128 
129 public:
130  std::string getName() const {return "Dirichlet";}
131 
132  void fireParameterChanged(const ParameterList& parameters);
133 
137  size_t getNumberOfCategories() const;
138 
145  Vdouble getValueCategory(Vdouble& Vvalue) const;
146 
147  VVdouble getCategories() const;
148 
153  virtual double getProbability(Vdouble& category) const;
154 
164  Vdouble rand() const;
165 
172  Vdouble randC() const;
173 
174 protected:
175  void discretize(Vdouble& valpha);
176 };
177 } // end of namespace bpp.
178 #endif // BPP_NUMERIC_PROB_DIRICHLETDISCRETEDISTRIBUTION_H
A partial implementation of the Parametrizable interface.
Discretized Dirichlet distribution. If the distribution is in n dimensions, the domain is the n-1 sim...
DirichletDiscreteDistribution * clone() const
Create a copy of this object and send a pointer to it.
Vdouble randC() const
Draw a random vector from the continuous version of this distribution.
DirichletDiscreteDistribution(std::vector< size_t > vn, Vdouble valpha)
Build a new discretized Dirichlet distribution.
Vdouble rand() const
Draw a random vector from this distribution.
std::vector< BetaDiscreteDistribution * > vpBDD_
void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
virtual double getProbability(Vdouble &category) const
Interface for multiple discrete distribution objects.
The parameter list object.
Definition: ParameterList.h:65
std::vector< double > Vdouble
Definition: VectorTools.h:70
std::vector< Vdouble > VVdouble
Definition: VectorTools.h:71