GOptimizerFunction.hpp
3.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/***************************************************************************
* GOptimizerFunction.hpp - Optimizer function abstract base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2014 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GOptimizerFunction.hpp
* @brief Optimizer function abstract base class
* @author Juergen Knoedlseder
*/
#ifndef GOPTIMIZERFUNCTION_HPP
#define GOPTIMIZERFUNCTION_HPP
/* __ Includes ___________________________________________________________ */
#include "GOptimizerPars.hpp"
#include "GVector.hpp"
#include "GMatrixSparse.hpp"
/***********************************************************************//**
* @class GOptimizerFunction
*
* @brief Optimizer function abstract base class
*
* This class provides an abstract interface for the function that is used
* by the GOptimizer optimization class.
*
* The eval() method returns the function value at a given set of parameters
* that is defined by an instance of the optimizer parameter container class
* GOptimizerPars. The value() method returns the actual function value at
* these parameters, and the gradient() and covar() methods return pointers
* on the gradient vector and the covariance matrix at the parameter values.
***************************************************************************/
class GOptimizerFunction {
public:
// Constructors and destructors
GOptimizerFunction(void);
GOptimizerFunction(const GOptimizerFunction& fct);
virtual ~GOptimizerFunction(void);
// Operators
virtual GOptimizerFunction& operator= (const GOptimizerFunction& fct);
// Virtual methods
virtual void eval(const GOptimizerPars& pars) = 0;
virtual double value(void) const = 0;
virtual GVector* gradient(void) = 0;
virtual GMatrixSparse* curvature(void) = 0;
protected:
// Protected methods
void init_members(void);
void copy_members(const GOptimizerFunction& fct);
void free_members(void);
};
#endif /* GOPTIMIZERFUNCTION_HPP */