GIntegral.hpp
10.6 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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
/***************************************************************************
* GIntegral.hpp - Integration class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-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 GIntegral.hpp
* @brief Integration class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GINTEGRAL_HPP
#define GINTEGRAL_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GBase.hpp"
/* __ Forward declarations _______________________________________________ */
class GFunction;
/***********************************************************************//**
* @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 GFunction.
***************************************************************************/
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;
std::string classname(void) const;
void max_iter(const int& iter);
const int& max_iter(void) const;
void fixed_iter(const int& iter);
const int& fixed_iter(void) const;
void eps(const double& eps);
const double& eps(void) const;
void silent(const bool& silent);
const bool& silent(void) const;
const int& iter(void) const;
const int& calls(void) const;
const bool& is_valid(void) const;
const std::string& message(void) const;
void kernel(GFunction* kernel);
const GFunction* kernel(void) const;
double romberg(std::vector<double> bounds,
const int& order = 5);
double romberg(const double& a, const double& b,
const int& order = 5);
double trapzd(const double& a,
const double& b,
const int& n = 1,
double result = 0.0);
double adaptive_simpson(const double& a, const double& b) const;
double gauss_kronrod(const double& a, const double& b) const;
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);
double adaptive_simpson_aux(const double& a, const double& b,
const double& eps, const double& S,
const double& fa, const double& fb,
const double& fc,
const int& bottom) const;
double rescale_error(double err,
const double& result_abs,
const double& result_asc) const;
// Protected data area
GFunction* m_kernel; //!< Pointer to function kernel
double m_eps; //!< Requested relative integration precision
int m_max_iter; //!< Maximum number of iterations
int m_fix_iter; //!< Fixed number of iterations
bool m_silent; //!< Suppress integration warnings in console
// Integrator results
mutable int m_iter; //!< Number of iterations used
mutable int m_calls; //!< Number of function calls used
mutable bool m_isvalid; //!< Integration result valid (true=yes)
mutable bool m_has_abserr; //!< Has absolute integration error
mutable bool m_has_relerr; //!< Has relative integration error
mutable double m_abserr; //!< Absolute integration error
mutable double m_relerr; //!< Absolute integration error
mutable std::string m_message; //!< Status message (if result is invalid)
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GIntegral").
***************************************************************************/
inline
std::string GIntegral::classname(void) const
{
return ("GIntegral");
}
/***********************************************************************//**
* @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] iter Maximum number of iterations.
***************************************************************************/
inline
void GIntegral::max_iter(const int& iter)
{
m_max_iter = 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 fixed number of iterations
*
* @param[in] iter Fixed number of iterations.
*
* If the fixed number of iterations is set, the integration algorithm will
* always performed the given number of iterations, irrespectively of the
* precision that is reached. This feature is relevant for computing
* numerical derivates from numerically integrated functions.
***************************************************************************/
inline
void GIntegral::fixed_iter(const int& iter)
{
m_fix_iter = iter;
return;
}
/***********************************************************************//**
* @brief Return fixed number of iterations
*
* @return Fixed number of iterations.
***************************************************************************/
inline
const int& GIntegral::fixed_iter(void) const
{
return m_fix_iter;
}
/***********************************************************************//**
* @brief Set relative precision
*
* @param[in] eps Relative precision.
***************************************************************************/
inline
void GIntegral::eps(const double& eps)
{
m_eps = eps;
return;
}
/***********************************************************************//**
* @brief Get relative precision
*
* @return Relative precision.
***************************************************************************/
inline
const double& GIntegral::eps(void) const
{
return m_eps;
}
/***********************************************************************//**
* @brief Get number of function calls
*
* @return Number of function calls.
***************************************************************************/
inline
const int& GIntegral::calls(void) const
{
return m_calls;
}
/***********************************************************************//**
* @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 function kernel
*
* @param[in] kernel Function kernel.
*
* Sets the function kernel for which the integral should be determined.
***************************************************************************/
inline
void GIntegral::kernel(GFunction* kernel)
{
m_kernel = kernel;
return;
}
/***********************************************************************//**
* @brief Get function kernel
*
* @return Function kernel.
***************************************************************************/
inline
const GFunction* GIntegral::kernel(void) const
{
return m_kernel;
}
/***********************************************************************//**
* @brief Signal if integration result is valid
*
* @return True is integration result is valid.
***************************************************************************/
inline
const bool& GIntegral::is_valid(void) const
{
return m_isvalid;
}
/***********************************************************************//**
* @brief Return integration status message
*
* @return Integration status message.
***************************************************************************/
inline
const std::string& GIntegral::message(void) const
{
return m_message;
}
#endif /* GINTEGRAL_HPP */