| The Gaudi Framework v27r1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

NumericalIndefiniteIntegral.h
Go to the documentation of this file.
1 #ifndef GAUDIMATH_NUMERICALINDEFINITEINTEGRAL_H
2 #define GAUDIMATH_NUMERICALINDEFINITEINTEGRAL_H 1
3 // ============================================================================
4 // Include files
5 // ============================================================================
6 // STD & STL
7 // ============================================================================
8 #include <string>
9 // ============================================================================
10 // GaudiKernel
11 // ============================================================================
12 #include "GaudiKernel/StatusCode.h"
13 // ============================================================================
14 // GaudiMath
15 // ============================================================================
16 #include "GaudiMath/Integration.h"
17 // ============================================================================
18 // CLHEP
19 // ============================================================================
20 #include "CLHEP/GenericFunctions/AbsFunction.hh"
21 // ============================================================================
22 #include "gsl/gsl_integration.h"
23
24
26
27 namespace Genfun
28 {
29 namespace GaudiMathImplementation
30 {
75 class GAUDI_API NumericalIndefiniteIntegral : public AbsFunction
76 {
77 public:
78 struct _Workspace { gsl_integration_workspace* ws ; };
79 struct _Function ;
80 public:
81
83 typedef std::vector<double> Points ;
84
85 public:
86
88 FUNCTION_OBJECT_DEF( NumericalIndefiniteIntegral )
89
90 public:
91
155 NumericalIndefiniteIntegral
156 ( const AbsFunction& function ,
157 const size_t index ,
158 const double a ,
159 const GaudiMath::Integration::Limit limit =
160 GaudiMath::Integration::VariableHighLimit ,
161 const GaudiMath::Integration::Type type =
162 GaudiMath::Integration::Adaptive ,
163 const GaudiMath::Integration::KronrodRule rule =
164 GaudiMath::Integration::Default ,
165 const double epsabs = 1e-10 ,
166 const double epsrel = 1.e-7 ,
167 const size_t size = 1000 );
168
210 NumericalIndefiniteIntegral
211 ( const AbsFunction& function ,
212 const size_t index ,
213 const double a ,
214 const Points& points ,
215 const GaudiMath::Integration::Limit limit =
216 GaudiMath::Integration::VariableHighLimit ,
217 const double epsabs = 1e-9 ,
218 const double epsrel = 1.e-6 ,
219 const size_t size = 1000 ) ;
220
258 NumericalIndefiniteIntegral
259 ( const AbsFunction& function ,
260 const size_t index ,
261 const GaudiMath::Integration::Limit limit =
262 GaudiMath::Integration::VariableHighLimit ,
263 const double epsabs = 1e-9 ,
264 const double epsrel = 1.e-6 ,
265 const size_t size = 1000 ) ;
266
268 NumericalIndefiniteIntegral
269 ( const NumericalIndefiniteIntegral& ) ;
270
272 virtual ~NumericalIndefiniteIntegral() = default;
273
274 public:
275
277 virtual unsigned int dimensionality() const { return m_DIM ; }
278
280 virtual double operator() ( double argument ) const ;
282 virtual double operator() ( const Argument& argument ) const ;
283
285 virtual bool hasAnalyticDerivative() const { return true ;}
286
288 virtual Genfun::Derivative partial ( unsigned int index ) const;
289
290 public:
291
293 const AbsFunction& function () const { return *m_function ; }
295 double a () const { return m_a ; }
297 const Points& points () const { return m_points ; }
299 double epsabs () const { return m_epsabs ; }
301 double epsrel () const { return m_epsrel ; }
302
304 double result () const { return m_result ; }
306 double error () const { return m_error ; }
307
308 // maximal number of bisection integvals for adaptive algorithms
309 size_t size () const { return m_size ; }
310
312 GaudiMath::Integration::Limit
313 limit () const { return m_limit ; }
315 GaudiMath::Integration::Type
316 type () const { return m_type ; }
318 GaudiMath::Integration::Category
319 category () const { return m_category ; }
321 GaudiMath::Integration::KronrodRule
322 rule () const { return m_rule ; }
323
324 protected:
325
326 // adaptive integration on infinite intervals
327 double QAGI ( _Function* fun ) const ;
328 // adaptive integration with known singular points
329 double QAGP ( _Function* fun ) const ;
330 // non-adaptive integration
331 double QNG ( _Function* fun ) const ;
332 // adaptive integration
333 double QAG ( _Function* fun ) const ;
334 // adaptive integral with singularities
335 double QAGS ( _Function* fun ) const ;
336
337 // allocate the integration workspace
338 _Workspace* allocate () const ;
339 // the integration workspace
340 _Workspace* ws () const
341 { return m_ws.get(); }
342
343 // throw the exception
344 StatusCode Exception
345 ( const std::string& message ,
346 const StatusCode& sc = StatusCode::FAILURE ) const ;
347
348 private:
349
350 // default constructor is disabled
351 NumericalIndefiniteIntegral() ;
352 // assignement operator is disabled
353 NumericalIndefiniteIntegral& operator=
354 ( const NumericalIndefiniteIntegral& ) ;
355
356 public:
357
358 struct gsl_ws_deleter {
359 void operator()(_Workspace* p) const {
360 if (p) gsl_integration_workspace_free ( p->ws ) ;
361 delete p;
362 }
363 };
364 private:
365
366 std::unique_ptr<const AbsFunction> m_function ;
367 size_t m_DIM ;
368 size_t m_index ;
369
370 double m_a ;
371
372 GaudiMath::Integration::Limit m_limit ;
373 GaudiMath::Integration::Type m_type ;
374 GaudiMath::Integration::Category m_category ;
375 GaudiMath::Integration::KronrodRule m_rule ;
376
377 Points m_points ;
378 std::unique_ptr<double[]> m_pdata ;
379
380 double m_epsabs ;
381 double m_epsrel ;
382
383 mutable double m_result ;
384 mutable double m_error ;
385
386 size_t m_size ;
387 mutable std::unique_ptr<_Workspace,gsl_ws_deleter> m_ws ;
388
389 mutable Argument m_argument ;
390
391 };
392
393 } // end of namespace GaudiMathImplementation
394 } // end of namespace Genfun
395
396 // ============================================================================
397 // The END
398 // ============================================================================
399 #endif // GAUDIMATH_NUMERICALINDEFINITEINTEGRAL_H
400 // ============================================================================
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_ws
std::unique_ptr< _Workspace, gsl_ws_deleter > m_ws
Definition: NumericalIndefiniteIntegral.h:387
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_error
double m_error
Definition: NumericalIndefiniteIntegral.h:384
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::epsrel
double epsrel() const
relatiove precision
Definition: NumericalIndefiniteIntegral.h:301
GaudiMath::Integration::Category
Category
integration category
Definition: Integration.h:30
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::result
double result() const
previous result
Definition: NumericalIndefiniteIntegral.h:304
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_pdata
std::unique_ptr< double[]> m_pdata
Definition: NumericalIndefiniteIntegral.h:378
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::error
double error() const
evaluate of previous error
Definition: NumericalIndefiniteIntegral.h:306
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_index
size_t m_index
Definition: NumericalIndefiniteIntegral.h:368
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_a
double m_a
Definition: NumericalIndefiniteIntegral.h:370
GaudiMath::Integration::Adaptive
Definition: Integration.h:26
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::limit
GaudiMath::Integration::Limit limit() const
integration limit
Definition: NumericalIndefiniteIntegral.h:313
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::size
size_t size() const
Definition: NumericalIndefiniteIntegral.h:309
GaudiMath::Derivative
Genfun::GaudiMathImplementation::NumericalDerivative Derivative
Definition: GaudiMath.h:29
merge_files.sc
int sc
Definition: merge_files.py:167
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::_Workspace::ws
gsl_integration_workspace * ws
Definition: NumericalIndefiniteIntegral.h:78
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::hasAnalyticDerivative
virtual bool hasAnalyticDerivative() const
Does this function have an analytic derivative?
Definition: NumericalIndefiniteIntegral.h:285
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::category
GaudiMath::Integration::Category category() const
integration category
Definition: NumericalIndefiniteIntegral.h:319
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::gsl_ws_deleter
Definition: NumericalIndefiniteIntegral.h:358
std::string
STL class.
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_epsabs
double m_epsabs
Definition: NumericalIndefiniteIntegral.h:380
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_size
size_t m_size
Definition: NumericalIndefiniteIntegral.h:386
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_DIM
size_t m_DIM
Definition: NumericalIndefiniteIntegral.h:367
gaudirun.type
string type
Definition: gaudirun.py:151
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::rule
GaudiMath::Integration::KronrodRule rule() const
integration rule
Definition: NumericalIndefiniteIntegral.h:322
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::_Function
Definition: NumericalIndefiniteIntegral.cpp:52
StatusCode::FAILURE
Definition: StatusCode.h:29
merge_files.default
list default
Definition: merge_files.py:105
Integration.h
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
GaudiMath::Integration::Type
Type
type of integration (for finite limits)
Definition: Integration.h:25
GaudiMath::Integration::VariableHighLimit
Definition: Integration.h:23
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_epsrel
double m_epsrel
Definition: NumericalIndefiniteIntegral.h:381
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::_Workspace
Definition: NumericalIndefiniteIntegral.h:78
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::epsabs
double epsabs() const
absolute precision
Definition: NumericalIndefiniteIntegral.h:299
GaudiMath::Integration::Default
Definition: Integration.h:41
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_limit
GaudiMath::Integration::Limit m_limit
Definition: NumericalIndefiniteIntegral.h:372
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_category
GaudiMath::Integration::Category m_category
Definition: NumericalIndefiniteIntegral.h:374
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::type
GaudiMath::Integration::Type type() const
integration type
Definition: NumericalIndefiniteIntegral.h:316
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_function
std::unique_ptr< const AbsFunction > m_function
Definition: NumericalIndefiniteIntegral.h:366
std::vector< double >
std::unique_ptr< const AbsFunction >
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::a
double a() const
integration limit
Definition: NumericalIndefiniteIntegral.h:295
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_type
GaudiMath::Integration::Type m_type
Definition: NumericalIndefiniteIntegral.h:373
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_argument
Argument m_argument
Definition: NumericalIndefiniteIntegral.h:389
GaudiMath::Integration::Limit
Limit
how to distinguish variable low and variable high limits
Definition: Integration.h:22
fun
double fun(const std::vector< double > &x)
Definition: PFuncTest.cpp:26
GaudiMath
GaudiMath.h GaudiMath/GaudiMath.h.
Definition: Adapters.h:13
GaudiMath::Integration::KronrodRule
KronrodRule
integration rule
Definition: Integration.h:34
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::Points
std::vector< double > Points
typedef for vector of singular points
Definition: NumericalIndefiniteIntegral.h:79
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_rule
GaudiMath::Integration::KronrodRule m_rule
Definition: NumericalIndefiniteIntegral.h:375
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_result
double m_result
Definition: NumericalIndefiniteIntegral.h:383
Genfun
CLHEP.
Definition: IEqSolver.h:13
StatusCode.h
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral
The simple class for numerical integrations.
Definition: NumericalIndefiniteIntegral.h:75
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:107
Tuples::Type
Type
the list of available types for ntuples
Definition: TupleObj.h:79
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::points
const Points & points() const
known singularities
Definition: NumericalIndefiniteIntegral.h:297
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::gsl_ws_deleter::operator()
void operator()(_Workspace *p) const
Definition: NumericalIndefiniteIntegral.h:359
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::ws
_Workspace * ws() const
Definition: NumericalIndefiniteIntegral.h:340
Genfun::GaudiMathImplementation::NumericalIndefiniteIntegral::m_points
Points m_points
Definition: NumericalIndefiniteIntegral.h:377
Integration
collection of common types for classes NumericalIndefiniteIntegral and NumericalDefiniteIntegral ...