GFunctions.hpp
3.02 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
/***************************************************************************
* GFunctions.hpp - Single parameter functions abstract base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2020 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 GFunctions.hpp
* @brief Single parameter functions abstract base class definition
* @author Juergen Knoedlseder
*/
#ifndef GFUNCTIONS_HPP
#define GFUNCTIONS_HPP
/* __ Includes ___________________________________________________________ */
/* __ Forward declarations _______________________________________________ */
class GVector;
/***********************************************************************//**
* @class GFunctions
*
* @brief Single parameter functions abstract base class
*
* This class implements the abstract interface for a set of one parameter
* functions.
*
* The set of functions is for example used for integration or numerical
* computation of derivatives. This class has no members. The only pure
* virtual method that needs to be implemented by the derived class is the
* eval() method that evaluates the functions at a given value x and returns
* the evaluation result as an GNdarray object.
***************************************************************************/
class GFunctions {
public:
// Constructors and destructors
GFunctions(void);
GFunctions(const GFunctions& functions);
virtual ~GFunctions(void);
// Operators
GFunctions& operator=(const GFunctions& functions);
// Methods
virtual int size(void) const = 0;
virtual GVector eval(const double& x) = 0;
protected:
// Protected methods
void init_members(void);
void copy_members(const GFunctions& functions);
void free_members(void);
};
#endif /* GFUNCTIONS_HPP */