bpp-core3  3.0.0
DirectionFunction.cpp
Go to the documentation of this file.
1 //
2 // File: DirectionFunction.cpp
3 // Authors:
4 // Julien Dutheil
5 // Created: 2007-04-11 17:28:00
6 //
7 
8 /*
9  Copyright or © or Copr. CNRS, (November 17, 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 
42 #include "DirectionFunction.h"
43 
44 using namespace bpp;
45 using namespace std;
46 
47 /******************************************************************************/
48 
50 {
51  params_ = params;
52  double x = params_[0].getValue();
53  for (unsigned int j = 0; j < p_.size(); j++)
54  {
55  // cout << p_[j].getValue() << " " << x << " " << xi_[j] << endl;
56  xt_[j].setValue((p_[j].getValue()) + x * xi_[j]);
57  }
58  function_->setParameters(xt_);
59 }
60 
61 /******************************************************************************/
62 
64 {
65  return function_->getValue();
66 }
67 
68 /******************************************************************************/
69 
71 {
72  return params_;
73 }
74 
76 {
77  return params_;
78 }
79 
80 /******************************************************************************/
81 
82 void DirectionFunction::init(const ParameterList& p, const vector<double>& xi)
83 {
84  p_ = p;
85  xi_ = xi;
86  if (constraintPolicy_ == AutoParameter::CONSTRAINTS_AUTO)
87  autoParameter();
88  else if (constraintPolicy_ == AutoParameter::CONSTRAINTS_IGNORE)
89  ignoreConstraints();
90  xt_ = p_;
91 }
92 
93 /******************************************************************************/
94 
96 {
97  for (unsigned int i = 0; i < p_.size(); i++)
98  {
99  AutoParameter ap(p_[i]);
100  ap.setMessageHandler(messenger_);
101  p_.setParameter(i, ap);
102  }
103 }
104 
105 /******************************************************************************/
106 
108 {
109  for (unsigned int i = 0; i < p_.size(); i++)
110  {
111  p_[i].removeConstraint();
112  }
113 }
114 
115 /******************************************************************************/
The AutoParameter class.
Definition: AutoParameter.h:61
static std::string CONSTRAINTS_AUTO
static std::string CONSTRAINTS_IGNORE
virtual void setMessageHandler(OutputStream *mh)
Set the message handler for this AutoParameter.
void init(const ParameterList &p, const std::vector< double > &xi)
const ParameterList & getParameters() const
Get all parameters available.
ParameterList & getParameters_()
Get all parameters available.
double getValue() const
Get the value of the function at the current point.
void setParameters(const ParameterList &parameters)
Set the point where the function must be computed.
The parameter list object.
Definition: ParameterList.h:65
virtual void setParameters(const ParameterList &params)
Update the parameters from params.