bpp-core3  3.0.0
InvariantMixedDiscreteDistribution.cpp
Go to the documentation of this file.
1 //
2 // File: InvariantMixedDiscreteDistribution.cpp
3 // Authors:
4 // Julien Dutheil
5 // Created: 2007-12-24 12:02:00
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Team, (November 17, 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 
42 #include "../../Utils/MapTools.h"
44 
45 using namespace bpp;
46 using namespace std;
47 
48 /******************************************************************************/
49 
51  DiscreteDistribution* dist, double p, double invariant) :
52  AbstractDiscreteDistribution(1, "Invariant."),
53  dist_(dist),
54  invariant_(invariant),
55  p_(p),
56  nestedPrefix_(dist->getNamespace())
57 {
58  // We first change the namespace of the nested distribution:
59  dist_->setNamespace("Invariant." + nestedPrefix_);
62 
64 }
65 
66 /******************************************************************************/
67 
69 {
71  p_ = getParameterValue("p");
72  dist_->matchParametersValues(parameters);
73 
75 }
76 
77 /******************************************************************************/
78 
80 {
81  distribution_.clear();
82  bounds_.clear();
83 
84  size_t distNCat = dist_->getNumberOfCategories();
85  vector<double> probs = dist_->getProbabilities();
86  vector<double> cats = dist_->getCategories();
87 
89  for (size_t i = 0; i < distNCat; i++)
90  {
91  if (cats[i] == invariant_)
92  distribution_[invariant_] += (1. - p_) * probs[i];
93  else
94  distribution_[cats[i]] = (1. - p_) * probs[i];
95  }
96 
97  intMinMax_->setLowerBound(dist_->getLowerBound(), !dist_->strictLowerBound());
98  intMinMax_->setUpperBound(dist_->getUpperBound(), !dist_->strictUpperBound());
99 
100  if (invariant_ <= intMinMax_->getLowerBound())
101  intMinMax_->setLowerBound(invariant_, true);
102  if (invariant_ >= intMinMax_->getUpperBound())
103  intMinMax_->setUpperBound(invariant_, true);
104 
106 
107  // bounds_
108 
109  // if invariant_ is between 2 values of dist_, bounds_ are set in the
110  // middle of the 3 values
111 
112  bool nv = true;
113 
114  double a = dist_->getCategory(0), b;
115  if (nv && (invariant_ < a))
116  {
117  bounds_.push_back((a + invariant_) / 2);
118  nv = false;
119  }
120 
121  for (size_t i = 1; i < distNCat; i++)
122  {
123  b = dist_->getCategory(i);
124  if (nv && (invariant_ < b))
125  {
126  bounds_.push_back((a + invariant_) / 2);
127  bounds_.push_back((invariant_ + b) / 2);
128  nv = false;
129  }
130  else
131  bounds_.push_back(dist_->getBound(i - 1));
132  a = b;
133  }
134 
135  if (nv)
136  bounds_.push_back((a + invariant_) / 2);
137 }
138 
139 /******************************************************************************/
140 
142 {
144  // We also need to update the namespace of the nested distribution:
145  dist_->setNamespace(prefix + nestedPrefix_);
146 }
147 
148 /******************************************************************************/
149 
151 {
152  if (!c.isCorrect(invariant_))
153  throw ConstraintException("Impossible to restrict to Constraint", &getParameter_("p"), invariant_);
154 
157 }
Partial implementation of the DiscreteDistribution interface.
std::map< double, double, Order > distribution_
double getLowerBound() const
methods about the range of the definition
std::shared_ptr< IntervalConstraint > intMinMax_
the interval where the distribution is defined/restricted.
void addParameters_(const ParameterList &parameters)
void addParameter_(Parameter *parameter)
void setNamespace(const std::string &prefix)
Set the namespace for the parameter names.
virtual void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
double getParameterValue(const std::string &name) const
Get the value for parameter of name 'name'.
Parameter & getParameter_(const std::string &name)
Exception thrown when a value do not match a given constraint.
The constraint interface.
Definition: Constraints.h:66
virtual bool isCorrect(double value) const =0
Tell if a given value is correct.
Interface for discrete distribution objects.
virtual double getBound(size_t) const =0
virtual bool strictLowerBound() const
virtual double getUpperBound() const
virtual double getCategory(size_t categoryIndex) const =0
virtual double getLowerBound() const
methods about the range of the definition
virtual Vdouble getCategories() const =0
virtual Vdouble getProbabilities() const =0
virtual bool strictUpperBound() const
virtual void restrictToConstraint(const Constraint &c)=0
Restricts the distribution to the domain where the constraint is respected, in addition of other pred...
virtual size_t getNumberOfCategories() const =0
void restrictToConstraint(const Constraint &c)
Restricts the distribution to the domain where the constraint is respected, in addition of other pred...
void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
void setNamespace(const std::string &prefix)
Set the namespace for the parameter names.
InvariantMixedDiscreteDistribution(DiscreteDistribution *dist, double p, double invariant=0.)
Build a new InvariantMixedDiscreteDistribution object.
virtual const ParameterList & getIndependentParameters() const =0
Get the minimal list of parameters to set the model.
The parameter list object.
Definition: ParameterList.h:65
This class is designed to facilitate the manipulation of parameters.
Definition: Parameter.h:135
static const std::shared_ptr< IntervalConstraint > PROP_CONSTRAINT_IN
Definition: Parameter.h:329
virtual bool matchParametersValues(const ParameterList &parameters)=0
Update the parameters from parameters.
virtual void setNamespace(const std::string &prefix)=0
Set the namespace for the parameter names.