bpp-core3  3.0.0
ConstantDistribution.cpp
Go to the documentation of this file.
1 //
2 // File: ConstantDistribution.cpp
3 // Authors:
4 // jdutheil
5 // Created: 2003-10-24 08:48:03
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 "ConstantDistribution.h"
43 
44 using namespace bpp;
45 
46 #include <iostream>
47 
48 using namespace std;
49 
50 /******************************************************************************/
51 
53  AbstractDiscreteDistribution(1, "Constant."),
54  value_(value)
55 {
56  addParameter_(new Parameter("Constant.value", value));
57  distribution_[value_] = 1; // One single class with probability 1.
58 }
59 
62  value_(cd.value_)
63 {}
64 
66 {
68  value_ = cd.value_;
69 
70  return *this;
71 }
72 
73 /******************************************************************************/
74 
76 {
78 
79  value_ = getParameterValue("value");
80  distribution_.clear();
81  distribution_[value_] = 1; // One single class of rate 1 with probability 1.
82 }
83 
84 /******************************************************************************/
85 
87 {
88  if (getNumberOfParameters() == 0)
89  return;
90 
91  const IntervalConstraint* pi = dynamic_cast<const IntervalConstraint*>(&c);
92  if (!pi)
93  throw Exception("ConstantDistribution::restrictToConstraint: Non-interval exception");
94 
95  if (!pi->isCorrect(getParameterValue("value")))
96  throw ConstraintException("Impossible to restrict to Constraint", &getParameter_("value"), getParameterValue("value"));
97 
99 
101 }
Partial implementation of the DiscreteDistribution interface.
virtual void restrictToConstraint(const Constraint &c)
Restricts the distribution to the domain where the constraint is respected, in addition of other pred...
std::map< double, double, Order > distribution_
AbstractDiscreteDistribution & operator=(const AbstractDiscreteDistribution &adde)
std::shared_ptr< IntervalConstraint > intMinMax_
the interval where the distribution is defined/restricted.
void addParameter_(Parameter *parameter)
virtual void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
size_t getNumberOfParameters() const
Get the number of parameters.
double getParameterValue(const std::string &name) const
Get the value for parameter of name 'name'.
Parameter & getParameter_(const std::string &name)
Constant discrete distribution.
ConstantDistribution(double value)
Builds a new ConstantDistribution object from a value.
ConstantDistribution & operator=(const ConstantDistribution &)
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.
Exception thrown when a value do not match a given constraint.
The constraint interface.
Definition: Constraints.h:66
Exception base class. Overload exception constructor (to control the exceptions mechanism)....
Definition: Exceptions.h:59
An interval, either bounded or not, which can also have infinite bounds.
Definition: Constraints.h:139
virtual bool isCorrect(double value) const
Tell if a given value is correct.
Definition: Constraints.h:230
The parameter list object.
Definition: ParameterList.h:65
This class is designed to facilitate the manipulation of parameters.
Definition: Parameter.h:135
virtual void setConstraint(std::shared_ptr< Constraint > constraint)
Set a constraint to this parameter.
Definition: Parameter.cpp:131