Object-oriented Scientific Computing Library: Version 0.910
Public Member Functions | Data Fields | Protected Attributes
inte< func_t > Class Template Reference

Base integration class [abstract base]. More...

#include <inte.h>

Inheritance diagram for inte< func_t >:
cern_adapt< func_t, nsub > cern_cauchy< func_t > cern_gauss< func_t > cern_gauss56< func_t > gsl_inte_kronrod< func_t > gsl_inte_qng< func_t > gsl_inte_qag< func_t > gsl_inte_singular< func_t > gsl_inte_qags< func_t > gsl_inte_transform< func_t > gsl_inte_cheb< func_t > gsl_inte_qagi< func_t > gsl_inte_qagil< func_t > gsl_inte_qagiu< func_t > gsl_inte_qawc< func_t > gsl_inte_qawo_sin< func_t > gsl_inte_qaws< func_t > gsl_inte_qawf_sin< func_t > gsl_inte_qawo_cos< func_t > gsl_inte_qawf_cos< func_t >

Detailed Description

template<class func_t = funct>
class inte< func_t >

Idea for Future:
It might be useful to have all of the integration classes report the number of function evaluations used in addition to the number of iterations which were taken

Definition at line 41 of file inte.h.

Public Member Functions

virtual double integ (func_t &func, double a, double b)
 Integrate function func from a to b.
virtual int integ_err (func_t &func, double a, double b, double &res, double &err)=0
 Integrate function func from a to b and place the result in res and the error in err.
double get_error ()
 Return the numerically estimated error in the result from the last call to integ()
virtual const char * type ()
 Return string denoting type ("inte")

Data Fields

int verbose
 Verbosity.
size_t last_iter
 The most recent number of iterations taken.
double tol_rel
 The maximum relative uncertainty in the value of the integral (default $ 10^{-8} $)
double tol_abs
 The maximum absolute uncertainty in the value of the integral (default $ 10^{-8} $)
bool err_nonconv
 If true, call the error handler if the routine does not converge or reach the desired tolerance (default true)
int last_conv
 Integer indicating convergence properties of the last call to integ() or integ_err().

Protected Attributes

double interror
 The uncertainty for the last integration computation.

Member Function Documentation

template<class func_t = funct>
double inte< func_t >::get_error ( ) [inline]

This will quietly return zero if no integrations have been performed or if the integrator does not estimate the error.

Definition at line 111 of file inte.h.


Field Documentation

template<class func_t = funct>
bool inte< func_t >::err_nonconv

If this is false, the function proceeds normally and may provide convergence information in last_conv.

Definition at line 79 of file inte.h.

template<class func_t = funct>
int inte< func_t >::last_conv

This is zero if the last call to integ() or integ_err() converged successfully. This variable is particularly useful, in combination with setting err_nonconv to false, to test for non-convergence without calling the error handler.

Definition at line 89 of file inte.h.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).

Get Object-oriented Scientific Computing
Lib at SourceForge.net. Fast, secure and Free Open Source software
downloads.