Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Math::VirtualIntegratorMultiDim Class Referenceabstract

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

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::IntegratorMultiDim.

Definition at line 160 of file VirtualIntegrator.h.

Public Member Functions

 ~VirtualIntegratorMultiDim () override
 destructor: no operation
 
virtual double Integral (const double *, const double *)=0
 evaluate multi-dim integral
 
virtual ROOT::Math::IntegratorMultiDimOptions Options () const =0
 get the option used for the integration implement by derived class otherwise return default ones
 
virtual void SetFunction (const IMultiGenFunction &)=0
 setting a multi-dim function
 
virtual void SetOptions (const ROOT::Math::IntegratorMultiDimOptions &opt)
 set the options (if needed must be re-implemented by derived classes)
 
virtual ROOT::Math::IntegrationMultiDim::Type Type () const
 return type of integrator
 
- Public Member Functions inherited from ROOT::Math::VirtualIntegrator
virtual ~VirtualIntegrator ()
 destructor: no operation
 
virtual double Error () const =0
 return the estimate of the absolute Error of the last Integral calculation
 
virtual int NEval () const
 return number of function evaluations in calculating the integral (if integrator do not implement this function returns -1)
 
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 SetRelTolerance (double)=0
 set the desired relative Error
 
virtual int Status () const =0
 return the Error Status of the last Integral calculation
 

#include <Math/VirtualIntegrator.h>

Inheritance diagram for ROOT::Math::VirtualIntegratorMultiDim:
[legend]

Constructor & Destructor Documentation

◆ ~VirtualIntegratorMultiDim()

ROOT::Math::VirtualIntegratorMultiDim::~VirtualIntegratorMultiDim ( )
inlineoverride

destructor: no operation

Definition at line 165 of file VirtualIntegrator.h.

Member Function Documentation

◆ Integral()

virtual double ROOT::Math::VirtualIntegratorMultiDim::Integral ( const double ,
const double  
)
pure virtual

evaluate multi-dim integral

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

◆ Options()

virtual ROOT::Math::IntegratorMultiDimOptions ROOT::Math::VirtualIntegratorMultiDim::Options ( ) const
pure virtual

get the option used for the integration implement by derived class otherwise return default ones

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

◆ SetFunction()

virtual void ROOT::Math::VirtualIntegratorMultiDim::SetFunction ( const IMultiGenFunction )
pure virtual

setting a multi-dim function

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

◆ SetOptions()

virtual void ROOT::Math::VirtualIntegratorMultiDim::SetOptions ( const ROOT::Math::IntegratorMultiDimOptions opt)
inlinevirtual

set the options (if needed must be re-implemented by derived classes)

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

Definition at line 183 of file VirtualIntegrator.h.

◆ Type()

virtual ROOT::Math::IntegrationMultiDim::Type ROOT::Math::VirtualIntegratorMultiDim::Type ( ) const
inlinevirtual

return type of integrator

Definition at line 178 of file VirtualIntegrator.h.

Libraries for ROOT::Math::VirtualIntegratorMultiDim:

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