bpp-core  2.2.0
NewtonBacktrackOneDimension.cpp
Go to the documentation of this file.
1 //
2 // File: NewtonBacktrackOneDimension.cpp
3 // Created by: Laurent Guéguen
4 // Created on: jeudi 16 décembre 2010, à 15h 45
5 //
6 
7 /*
8  Copyright or © or Copr. CNRS, (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 
41 #include "../NumTools.h"
42 #include "../../Text/TextTools.h"
43 
44 using namespace bpp;
45 
46 /******************************************************************************/
47 
49  AbstractOptimizer(function),
50  fold_(0), f_(0), a_(0), alam_(0), alamin_(0), alam2_(0), b_(0), disc_(0), f2_(0), rhs1_(0), rhs2_(0), slope_(slope), test_(test), tmplam_(0)
51 
52 {
56 }
57 
58 /******************************************************************************/
59 
61 {
62  // Set the initial value (no use here! Use setInitialValues() instead).
63  if(params.size() != 1) throw Exception("NewtonBacktrackOneDimension::init(). This optimizer only deals with one parameter.");
64  fold_ = getFunction()->f(getParameters());
65  getStopCondition()->setTolerance(getStopCondition()->getTolerance()/test_);
66  alamin_=getStopCondition()->getTolerance();
67  alam_=1;
68 }
69 
70 /******************************************************************************/
71 
73 {
74  if (alam_<alamin_){
75  getParameter_(0).setValue(0);
76  tolIsReached_=true;
77  return fold_;
78  }
79 
81  f_ = getFunction()->f(getParameters());
82 
83  if (f_<=fold_+alam_*0.0001*slope_){
84  tolIsReached_=true;
85  return f_;
86  }
87 
88  if (alam_==1){
89  tmplam_=-slope_/(2.0*(f_-fold_-slope_));
90  f2_=f_;
91  alam_=tmplam_>0.1?tmplam_:0.1;
92  return f_;
93  }
94 
97 
100 
101  if (a_==0.0)
102  tmplam_= -slope_/(2.0*b_);
103  else {
104  disc_=b_*b_-3.0*a_*slope_;
105  if (disc_<0.0)
106  tmplam_=0.5*alam_;
107  else
108  if (b_<=0)
109  tmplam_=(-b_+sqrt(disc_))/(3.0*a_);
110  else
111  tmplam_=-slope_/(b_+sqrt(disc_));
112  }
113  if (tmplam_> 0.5* alam_)
114  tmplam_=0.5*alam_;
115 
116  alam2_=alam_;
117  f2_=f_;
118  alam_=tmplam_>0.1*alam_?tmplam_:0.1*alam_;
119 
120  return f_;
121 }
122 
123 /******************************************************************************/
124 
virtual double f(const ParameterList &parameters)
Get the value of the function according to a given set of parameters.
Definition: Functions.h:117
This class allows to perform a correspondence analysis.
This is the function abstract class.
Definition: Functions.h:86
void doInit(const ParameterList &params)
This function is called by the init() method and contains all calculations.
void setMaximumNumberOfEvaluations(unsigned int max)
Set the maximum number of function evaluation to perform during optimization.
The parameter list object.
Definition: ParameterList.h:61
NewtonBacktrackOneDimension(Function *function, double slope, double test)
bool tolIsReached_
Tell if the tolerance level has been reached.
virtual void setValue(double value)
Set the value of this parameter.
Definition: Parameter.cpp:123
void setDefaultStopCondition_(OptimizationStopCondition *osc)
double doStep()
This function is called by the step() method and contains all calculations.
Parameter & getParameter_(size_t i)
const Function * getFunction() const
Get the current function being optimized.
const ParameterList & getParameters() const
Exception base class.
Definition: Exceptions.h:57
Partial implementation of the Optimizer interface.
void setStopCondition(const OptimizationStopCondition &stopCondition)
Set the stop condition of the optimization algorithm.
OptimizationStopCondition * getDefaultStopCondition()
Get the default stop condition of the optimization algorithm.