bpp-core3  3.0.0
GoldenSectionSearch.h
Go to the documentation of this file.
1 //
2 // File: GoldenSectionSearch.h
3 // Authors:
4 // Julien Dutheil
5 // Created: 2003-11-10 10:42:17
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 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 #ifndef BPP_NUMERIC_FUNCTION_GOLDENSECTIONSEARCH_H
42 #define BPP_NUMERIC_FUNCTION_GOLDENSECTIONSEARCH_H
43 
44 
45 #include "AbstractOptimizer.h"
46 
47 namespace bpp
48 {
61  public AbstractOptimizer
62 {
63 public:
66  {
67 public:
70  virtual ~GSSStopCondition() {}
71 
72  GSSStopCondition* clone() const { return new GSSStopCondition(*this); }
73 
74 public:
75  bool isToleranceReached() const;
76  double getCurrentTolerance() const;
77  };
78 
79  friend class GSSStopCondition;
80 
81 private:
82  double f1, f2, x0, x1, x2, x3;
83  double xinf_, xsup_;
85 
86 public:
87  GoldenSectionSearch(Function* function);
88  virtual ~GoldenSectionSearch() {}
89 
90  GoldenSectionSearch* clone() const { return new GoldenSectionSearch(*this); }
91 
92 public:
110  double getFunctionValue() const;
113  void doInit(const ParameterList& params);
114 
115  double doStep();
116 
129  void setInitialInterval(double inf, double sup);
136 
137 protected:
138 };
139 } // end of namespace bpp.
140 #endif // BPP_NUMERIC_FUNCTION_GOLDENSECTIONSEARCH_H
Partial implementation of the OptimizationStopCondition interface.
Partial implementation of the Optimizer interface.
This is the function abstract class.
Definition: Functions.h:89
GSSStopCondition * clone() const
Create a copy of this object and send a pointer to it.
bool isToleranceReached() const
Tell if the we reached the desired tolerance with a given new set of estimates.
double getCurrentTolerance() const
Get the current tolerance.
Golden Section Search optimization algorithm for one parameter.
GoldenSectionSearch * clone() const
Create a copy of this object and send a pointer to it.
void setInitialInterval(double inf, double sup)
Set intial search interval.
double doStep()
This function is called by the step() method and contains all calculations.
void doInit(const ParameterList &params)
This function is called by the init() method and contains all calculations.
GoldenSectionSearch(Function *function)
double getFunctionValue() const
Initialize optimizer.
The parameter list object.
Definition: ParameterList.h:65