GIntegral.hpp
6.51 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/***************************************************************************
* GIntegral.hpp - Integration class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2013 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 GIntegral.hpp
* @brief Integration class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GINTEGRAL_HPP
#define GINTEGRAL_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GFunction.hpp"
/***********************************************************************//**
* @class GIntegral
*
* @brief GIntegral class interface definition.
*
* This class allows to perform integration using various methods. The
* integrand is implemented by a derived class of GIntegrand.
***************************************************************************/
class GIntegral : public GBase {
public:
// Constructors and destructors
explicit GIntegral(void);
explicit GIntegral(GFunction* kernel);
GIntegral(const GIntegral& integral);
virtual ~GIntegral(void);
// Operators
GIntegral& operator=(const GIntegral& integral);
// Methods
void clear(void);
GIntegral* clone(void) const;
void max_iter(const int& max_iter);
void eps(const double& eps);
void silent(const bool& silent);
const int& iter(void) const;
const int& max_iter(void) const;
const double& eps(void) const;
const bool& silent(void) const;
void kernel(GFunction* kernel);
const GFunction* kernel(void) const;
double romb(const double& a, const double& b, const int& k = 5);
double trapzd(const double& a, const double& b, const int& n = 1,
double result = 0.0);
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GIntegral& integral);
void free_members(void);
double polint(double* xa, double* ya, int n, double x, double *dy);
// Protected data area
GFunction* m_kernel; //!< Pointer to function kernel
double m_eps; //!< Integration precision
int m_max_iter; //!< Maximum number of iterations
int m_iter; //!< Number of iterations used
bool m_silent; //!< Suppress integration warnings
};
/***********************************************************************//**
* @brief Return number of iterations
*
* @return Number of iterations.
***************************************************************************/
inline
const int& GIntegral::iter(void) const
{
return m_iter;
}
/***********************************************************************//**
* @brief Set maximum number of iterations
*
* @param[in] max_iter Maximum number of iterations.
***************************************************************************/
inline
void GIntegral::max_iter(const int& max_iter)
{
m_max_iter = max_iter;
return;
}
/***********************************************************************//**
* @brief Return maximum number of iterations
*
* @return Maximum number of iterations.
***************************************************************************/
inline
const int& GIntegral::max_iter(void) const
{
return m_max_iter;
}
/***********************************************************************//**
* @brief Set precision
*
* @param[in] eps Precision.
***************************************************************************/
inline
void GIntegral::eps(const double& eps)
{
m_eps = eps;
return;
}
/***********************************************************************//**
* @brief Get precision
*
* @return Precision.
***************************************************************************/
inline
const double& GIntegral::eps(void) const
{
return m_eps;
}
/***********************************************************************//**
* @brief Set silence flag
*
* @param[in] silent Silence flag.
***************************************************************************/
inline
void GIntegral::silent(const bool& silent)
{
m_silent = silent;
return;
}
/***********************************************************************//**
* @brief Get silence flag
*
* @return True is class is silent, false otherwise.
***************************************************************************/
inline
const bool& GIntegral::silent(void) const
{
return m_silent;
}
/***********************************************************************//**
* @brief Set kernel
*
* @param[in] kernel Kernel.
*
* Sets the kernel for which the integral should be determined.
***************************************************************************/
inline
void GIntegral::kernel(GFunction* kernel)
{
m_kernel = kernel;
return;
}
/***********************************************************************//**
* @brief Get kernel
*
* @return Kernel.
***************************************************************************/
inline
const GFunction* GIntegral::kernel(void) const
{
return m_kernel;
}
#endif /* GINTEGRAL_HPP */