Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
ROOT::Math::VirtualIntegratorOneDim Class Referenceabstract
Math » Core Math Functionality (MathCore) » Numerical Algorithms » Numerical Integration

Interface (abstract) class for 1D numerical integration It must be implemented by the concrete Integrator classes like ROOT::Math::GSLIntegrator.

Plug-in's exist in ROOT to be able to instantiate the derived classes via the plug-in manager. Users should not use directly this class but the concrete classes ROOT::Math::IntegratorOneDim.

Definition at line 101 of file VirtualIntegrator.h.

Public Member Functions

 ~VirtualIntegratorOneDim () override
 destructor: no operation
virtual double Error () const =0
 return the estimate of the absolute Error of the last Integral calculation
virtual double Integral ()=0
 evaluate un-defined integral (between -inf, + inf)
virtual double Integral (const std::vector< double > &pts)=0
 evaluate integral with singular points
virtual double Integral (double a, double b)=0
 evaluate integral
virtual double IntegralCauchy (double a, double b, double c)=0
 evaluate Cauchy integral
virtual double IntegralLow (double b)=0
 evaluate integral over the (-inf, b)
virtual double IntegralUp (double a)=0
 evaluate integral over the (a, +inf)
virtual int NEval () const
 return number of function evaluations in calculating the integral (if integrator do not implement this function returns -1)
virtual ROOT::Math::IntegratorOneDimOptions Options () const =0
 get the option used for the integration must be implemented by derived class
virtual double Result () const =0
 return the Result of the last Integral calculation
virtual void SetAbsTolerance (double)=0
 set the desired absolute Error
virtual void SetFunction (const IGenFunction &)=0
 set integration function
virtual void SetOptions (const ROOT::Math::IntegratorOneDimOptions &opt)
 set the options (should be re-implemented by derived classes -if more options than tolerance exist
virtual void SetRelTolerance (double)=0
 set the desired relative Error
virtual int Status () const =0
 return the Error Status of the last Integral calculation
virtual ROOT::Math::IntegrationOneDim::Type Type () const
 return type of integrator

#include <Math/VirtualIntegrator.h>

Inheritance diagram for ROOT::Math::VirtualIntegratorOneDim:
ROOT::Math::VirtualIntegrator ROOT::Math::GSLIntegrator ROOT::Math::GaussIntegrator ROOT::Math::GaussLegendreIntegrator

Constructor & Destructor Documentation

◆ ~VirtualIntegratorOneDim()

ROOT::Math::VirtualIntegratorOneDim::~VirtualIntegratorOneDim ( )
inlineoverride

destructor: no operation

Definition at line 106 of file VirtualIntegrator.h.

Member Function Documentation

◆ Error()

virtual double ROOT::Math::VirtualIntegrator::Error ( ) const
pure virtualinherited

return the estimate of the absolute Error of the last Integral calculation

Implemented in ROOT::Math::AdaptiveIntegratorMultiDim, ROOT::Math::GaussIntegrator, ROOT::Math::GSLIntegrator, and ROOT::Math::GSLMCIntegrator.

◆ Integral() [1/3]

virtual double ROOT::Math::VirtualIntegratorOneDim::Integral ( )
pure virtual

evaluate un-defined integral (between -inf, + inf)

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ Integral() [2/3]

virtual double ROOT::Math::VirtualIntegratorOneDim::Integral ( const std::vector< double > & pts)
pure virtual

evaluate integral with singular points

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ Integral() [3/3]

virtual double ROOT::Math::VirtualIntegratorOneDim::Integral ( double a,
double b )
pure virtual

evaluate integral

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ IntegralCauchy()

virtual double ROOT::Math::VirtualIntegratorOneDim::IntegralCauchy ( double a,
double b,
double c )
pure virtual

evaluate Cauchy integral

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ IntegralLow()

virtual double ROOT::Math::VirtualIntegratorOneDim::IntegralLow ( double b)
pure virtual

evaluate integral over the (-inf, b)

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ IntegralUp()

virtual double ROOT::Math::VirtualIntegratorOneDim::IntegralUp ( double a)
pure virtual

evaluate integral over the (a, +inf)

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ NEval()

virtual int ROOT::Math::VirtualIntegrator::NEval ( ) const
inlinevirtualinherited

return number of function evaluations in calculating the integral (if integrator do not implement this function returns -1)

Reimplemented in ROOT::Math::AdaptiveIntegratorMultiDim, ROOT::Math::GaussLegendreIntegrator, ROOT::Math::GSLIntegrator, and ROOT::Math::GSLMCIntegrator.

Definition at line 84 of file VirtualIntegrator.h.

◆ Options()

virtual ROOT::Math::IntegratorOneDimOptions ROOT::Math::VirtualIntegratorOneDim::Options ( ) const
pure virtual

get the option used for the integration must be implemented by derived class

Implemented in ROOT::Math::GaussIntegrator, ROOT::Math::GaussLegendreIntegrator, and ROOT::Math::GSLIntegrator.

◆ Result()

virtual double ROOT::Math::VirtualIntegrator::Result ( ) const
pure virtualinherited

return the Result of the last Integral calculation

Implemented in ROOT::Math::AdaptiveIntegratorMultiDim, ROOT::Math::GaussIntegrator, ROOT::Math::GSLIntegrator, and ROOT::Math::GSLMCIntegrator.

◆ SetAbsTolerance()

virtual void ROOT::Math::VirtualIntegrator::SetAbsTolerance ( double )
pure virtualinherited

set the desired absolute Error

Implemented in ROOT::Math::AdaptiveIntegratorMultiDim, ROOT::Math::GaussIntegrator, ROOT::Math::GaussLegendreIntegrator, ROOT::Math::GSLIntegrator, and ROOT::Math::GSLMCIntegrator.

◆ SetFunction()

virtual void ROOT::Math::VirtualIntegratorOneDim::SetFunction ( const IGenFunction & )
pure virtual

set integration function

Implemented in ROOT::Math::GaussIntegrator, and ROOT::Math::GSLIntegrator.

◆ SetOptions()

virtual void ROOT::Math::VirtualIntegratorOneDim::SetOptions ( const ROOT::Math::IntegratorOneDimOptions & opt)
inlinevirtual

set the options (should be re-implemented by derived classes -if more options than tolerance exist

Reimplemented in ROOT::Math::GaussIntegrator, ROOT::Math::GaussLegendreIntegrator, and ROOT::Math::GSLIntegrator.

Definition at line 140 of file VirtualIntegrator.h.

◆ SetRelTolerance()

virtual void ROOT::Math::VirtualIntegrator::SetRelTolerance ( double )
pure virtualinherited

set the desired relative Error

Implemented in ROOT::Math::AdaptiveIntegratorMultiDim, ROOT::Math::GaussIntegrator, ROOT::Math::GaussLegendreIntegrator, ROOT::Math::GSLIntegrator, and ROOT::Math::GSLMCIntegrator.

◆ Status()

virtual int ROOT::Math::VirtualIntegrator::Status ( ) const
pure virtualinherited

return the Error Status of the last Integral calculation

Implemented in ROOT::Math::AdaptiveIntegratorMultiDim, ROOT::Math::GaussIntegrator, ROOT::Math::GSLIntegrator, and ROOT::Math::GSLMCIntegrator.

◆ Type()

virtual ROOT::Math::IntegrationOneDim::Type ROOT::Math::VirtualIntegratorOneDim::Type ( ) const
inlinevirtual

return type of integrator

Definition at line 134 of file VirtualIntegrator.h.

The documentation for this class was generated from the following file: