bpp-core  2.2.0
ConstantDistribution.cpp
Go to the documentation of this file.
1 //
2 // File: ConstantDistribution.cpp
3 // Created by: jdutheil
4 // Created on: Fri Oct 24 08:48:03 2003
5 //
6 
7 /*
8 Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
9 
10 This software is a computer program whose purpose is to provide classes
11 for numerical calculus.
12 
13 This software is governed by the CeCILL license under French law and
14 abiding by the rules of distribution of free software. You can use,
15 modify and/ or redistribute the software under the terms of the CeCILL
16 license as circulated by CEA, CNRS and INRIA at the following URL
17 "http://www.cecill.info".
18 
19 As a counterpart to the access to the source code and rights to copy,
20 modify and redistribute granted by the license, users are provided only
21 with a limited warranty and the software's author, the holder of the
22 economic rights, and the successive licensors have only limited
23 liability.
24 
25 In this respect, the user's attention is drawn to the risks associated
26 with loading, using, modifying and/or developing or reproducing the
27 software by the user in light of its specific status of free software,
28 that may mean that it is complicated to manipulate, and that also
29 therefore means that it is reserved for developers and experienced
30 professionals having in-depth computer knowledge. Users are therefore
31 encouraged to load and test the software's suitability as regards their
32 requirements in conditions enabling the security of their systems and/or
33 data to be ensured and, more generally, to use and operate it in the
34 same conditions as regards security.
35 
36 The fact that you are presently reading this means that you have had
37 knowledge of the CeCILL license and that you accept its terms.
38 */
39 
40 #include "ConstantDistribution.h"
41 
42 using namespace bpp;
43 
44 #include <iostream>
45 
46 using namespace std;
47 
48 /******************************************************************************/
49 
51  AbstractParameterAliasable("Constant."),
52  AbstractDiscreteDistribution(1, "Constant."),
53  value_(value)
54 {
55  addParameter_(new Parameter("Constant.value", value));
56  distribution_[value_] = 1; //One single class with probability 1.
57 }
58 
62  value_(cd.value_)
63 {}
64 
66 {
69  value_=cd.value_;
70 
71  return *this;
72 }
73 
74 /******************************************************************************/
75 
77 {
79 
80  value_=getParameterValue("value");
81  distribution_.clear();
82  distribution_[value_] = 1; //One single class of rate 1 with probability 1.
83 }
84 
85 /******************************************************************************/
86 
88 {
89  if (getNumberOfParameters()==0)
90  return;
91 
92  const IntervalConstraint* pi=dynamic_cast<const IntervalConstraint*>(&c);
93  if (!pi)
94  throw Exception("ConstantDistribution::restrictToConstraint: Non-interval exception");
95 
96  if (! pi->isCorrect(getParameterValue("value")))
97  throw ConstraintException("Impossible to restrict to Constraint", &getParameter_("value"), getParameterValue("value"));
98 
100 
101  Parameter& p=getParameter_("value");
102  p.setConstraint(intMinMax_.clone(),true);
103  }
ConstantDistribution & operator=(const ConstantDistribution &)
void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
Partial implementation of the DiscreteDistribution interface.
An interval, either bounded or not, which can also have infinite bounds.
Definition: Constraints.h:135
This class allows to perform a correspondence analysis.
virtual bool isCorrect(double value) const
Tell if a given value is correct.
Definition: Constraints.h:228
IntervalConstraint * clone() const
Create a copy of this object and send a pointer to it.
Definition: Constraints.h:207
STL namespace.
This class is designed to facilitate the manipulation of parameters.
Definition: Parameter.h:135
void addParameter_(Parameter *parameter)
size_t getNumberOfParameters() const
Get the number of parameters.
The parameter list object.
Definition: ParameterList.h:61
AbstractDiscreteDistribution & operator=(const AbstractDiscreteDistribution &adde)
A partial implementation of the Parametrizable interface.
virtual void setConstraint(Constraint *constraint, bool attach=false)
Set a constraint to this parameter.
Definition: Parameter.cpp:143
The constraint interface.
Definition: Constraints.h:62
std::map< double, double, Order > distribution_
ConstantDistribution(double value)
Builds a new ConstantDistribution object from a value.
AbstractParameterAliasable & operator=(const AbstractParameterAliasable &ap)
Exception base class.
Definition: Exceptions.h:57
Constant discrete distribution.
Exception thrown when a value do not match a given constraint.
Parameter & getParameter_(const std::string &name)
void fireParameterChanged(const ParameterList &parameters)
Notify the class when one or several parameters have changed.
IntervalConstraint intMinMax_
the interval where the distribution is defined/restricted.
void restrictToConstraint(const Constraint &c)
Restricts the distribution to the domain where the constraint is respected, in addition of other pred...
double getParameterValue(const std::string &name) const
Get the value for parameter of name &#39;name&#39;.
virtual void restrictToConstraint(const Constraint &c)
Restricts the distribution to the domain where the constraint is respected, in addition of other pred...