bpp-core  2.2.0
TwoPointsNumericalDerivative.h
Go to the documentation of this file.
1 //
2 // File: TwoPointsNumericalDerivative.h
3 // Created by: Julien Dutheil
4 // Created on: Mon May 28 10:33 2007
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 
40 #ifndef _TWOPOINTSNUMERICALDERIVATIVE_H_
41 #define _TWOPOINTSNUMERICALDERIVATIVE_H_
42 
43 #include "Functions.h"
45 
46 // From the STL:
47 #include <map>
48 #include <vector>
49 #include <string>
50 
51 namespace bpp
52 {
76 {
77 private:
78  double f1_, f2_;
79 
80 public:
83  f1_(),
84  f2_() {}
87  f1_(),
88  f2_() {}
90 
92 
93 public:
94  double getValue() const throw (Exception) { return f1_; }
95 
101  double getSecondOrderDerivative(const std::string& variable) const
102  throw (Exception)
103  {
104  throw Exception("Second order derivative not avalaible with two points method.");
105  }
106 
107  double getSecondOrderDerivative(const std::string& variable1, const std::string& variable2) const
108  throw (Exception)
109  {
110  throw Exception("Unimplemented cross derivative.");
111  }
114 protected:
115  void updateDerivatives(const ParameterList parameters)
117 };
118 } // end of namespace bpp.
119 
120 #endif // _TWOPOINTSNUMERICALDERIVATIVE_H_
121 
double getSecondOrderDerivative(const std::string &variable) const
Get the second order derivative of the function at the current point.
Exception thrown when a parameter is not found, for instance in a ParameterList.
double getSecondOrderDerivative(const std::string &variable1, const std::string &variable2) const
Get the value of the cross derivative of the function according to a given set of parameters...
void updateDerivatives(const ParameterList parameters)
Compute derivatives.
This class allows to perform a correspondence analysis.
This is the function abstract class.
Definition: Functions.h:86
Numerical derivative function wrapper, partial implementation.
TwoPointsNumericalDerivative * clone() const
Create a copy of this object and send a pointer to it.
The parameter list object.
Definition: ParameterList.h:61
Exception base class.
Definition: Exceptions.h:57
This is the abstract class for first order derivable functions.
Definition: Functions.h:129
Exception thrown when a value do not match a given constraint.
Two points numerical derivative function wrapper.
double getValue() const
Get the value of the function at the current point.
TwoPointsNumericalDerivative(DerivableFirstOrder *function)