ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ROOT::Math::BaseIntegratorOptions Class Referenceabstract
Math » MathCoreMath » | MathMore » Numerical Algorithms » Numerical Integration

Base class for Numerical integration options common in 1D and multi-dimension This is an internal class and is not supposed to be instantiated by the user.

Definition at line 37 of file IntegratorOptions.h.

Public Member Functions

 BaseIntegratorOptions (const BaseIntegratorOptions &opt)
 
BaseIntegratorOptions & operator= (const BaseIntegratorOptions &opt)
 assignment operators More...
 
virtual ~BaseIntegratorOptions ()
 protected constructor to avoid user creating this class More...
 
virtual std::string Integrator () const =0
 name of 1D integrator More...
 
double AbsTolerance () const
 non-static methods for retrivieng options More...
 
double RelTolerance () const
 absolute tolerance More...
 
unsigned int WKSize () const
 size of the workspace More...
 
IOptions * ExtraOptions () const
 return extra options More...
 
void SetAbsTolerance (double tol)
 non-static methods for setting options More...
 
void SetRelTolerance (double tol)
 set the relative tolerance More...
 
void SetWKSize (unsigned int size)
 set workspace size More...
 
void SetExtraOptions (const IOptions &opt)
 set extra options (in this case pointer is cloned) More...
 

Protected Member Functions

 BaseIntegratorOptions ()
 protected constructor to avoid user creating this class More...
 
void ClearExtra ()
 

Protected Attributes

int fIntegType
 
unsigned int fWKSize
 
unsigned int fNCalls
 
double fAbsTolerance
 
double fRelTolerance
 
ROOT::Math::IOptions * fExtraOptions
 

#include <Math/IntegratorOptions.h>

+ Inheritance diagram for ROOT::Math::BaseIntegratorOptions:
+ Collaboration diagram for ROOT::Math::BaseIntegratorOptions:

Constructor & Destructor Documentation

ROOT::Math::BaseIntegratorOptions::BaseIntegratorOptions ( )
protected

protected constructor to avoid user creating this class

constructor (protected) to avoid user creating this class

Definition at line 125 of file IntegratorOptions.cxx.

ROOT::Math::BaseIntegratorOptions::BaseIntegratorOptions ( const BaseIntegratorOptions &  opt)

Definition at line 132 of file IntegratorOptions.cxx.

virtual ROOT::Math::BaseIntegratorOptions::~BaseIntegratorOptions ( )
inlinevirtual

protected constructor to avoid user creating this class

Definition at line 54 of file IntegratorOptions.h.

Member Function Documentation

double ROOT::Math::BaseIntegratorOptions::AbsTolerance ( ) const
inline

non-static methods for retrivieng options

absolute tolerance

Definition at line 63 of file IntegratorOptions.h.

Referenced by ROOT::Math::VirtualIntegratorOneDim::SetOptions(), ROOT::Math::AdaptiveIntegratorMultiDim::SetOptions(), ROOT::Math::VirtualIntegratorMultiDim::SetOptions(), ROOT::Math::GaussIntegrator::SetOptions(), ROOT::Math::GSLMCIntegrator::SetOptions(), and ROOT::Math::GSLIntegrator::SetOptions().

void ROOT::Math::BaseIntegratorOptions::ClearExtra ( )
protected

Definition at line 161 of file IntegratorOptions.cxx.

Referenced by operator=(), SetExtraOptions(), and ~BaseIntegratorOptions().

IOptions* ROOT::Math::BaseIntegratorOptions::ExtraOptions ( ) const
inline

return extra options

Definition at line 73 of file IntegratorOptions.h.

Referenced by ROOT::Math::GSLMCIntegrator::SetOptions().

virtual std::string ROOT::Math::BaseIntegratorOptions::Integrator ( ) const
pure virtual

name of 1D integrator

Implemented in ROOT::Math::IntegratorMultiDimOptions, and ROOT::Math::IntegratorOneDimOptions.

BaseIntegratorOptions & ROOT::Math::BaseIntegratorOptions::operator= ( const BaseIntegratorOptions &  opt)

assignment operators

Definition at line 137 of file IntegratorOptions.cxx.

double ROOT::Math::BaseIntegratorOptions::RelTolerance ( ) const
inline

absolute tolerance

Definition at line 66 of file IntegratorOptions.h.

Referenced by ROOT::Math::GaussLegendreIntegrator::SetOptions(), ROOT::Math::VirtualIntegratorOneDim::SetOptions(), ROOT::Math::AdaptiveIntegratorMultiDim::SetOptions(), ROOT::Math::VirtualIntegratorMultiDim::SetOptions(), ROOT::Math::GaussIntegrator::SetOptions(), ROOT::Math::GSLMCIntegrator::SetOptions(), and ROOT::Math::GSLIntegrator::SetOptions().

void ROOT::Math::BaseIntegratorOptions::SetAbsTolerance ( double  tol)
inline

non-static methods for setting options

set the abs tolerance

Definition at line 79 of file IntegratorOptions.h.

Referenced by ROOT::Math::GaussLegendreIntegrator::Options(), ROOT::Math::AdaptiveIntegratorMultiDim::Options(), ROOT::Math::GaussIntegrator::Options(), ROOT::Math::GSLMCIntegrator::Options(), and ROOT::Math::GSLIntegrator::Options().

void ROOT::Math::BaseIntegratorOptions::SetExtraOptions ( const IOptions &  opt)

set extra options (in this case pointer is cloned)

Definition at line 167 of file IntegratorOptions.cxx.

void ROOT::Math::BaseIntegratorOptions::SetRelTolerance ( double  tol)
inline

set the relative tolerance

Definition at line 82 of file IntegratorOptions.h.

Referenced by ROOT::Math::GaussLegendreIntegrator::Options(), ROOT::Math::AdaptiveIntegratorMultiDim::Options(), ROOT::Math::GaussIntegrator::Options(), ROOT::Math::GSLMCIntegrator::Options(), and ROOT::Math::GSLIntegrator::Options().

void ROOT::Math::BaseIntegratorOptions::SetWKSize ( unsigned int  size)
inline

set workspace size

Definition at line 85 of file IntegratorOptions.h.

Referenced by ROOT::Math::GaussLegendreIntegrator::Options(), ROOT::Math::AdaptiveIntegratorMultiDim::Options(), ROOT::Math::GaussIntegrator::Options(), ROOT::Math::GSLMCIntegrator::Options(), and ROOT::Math::GSLIntegrator::Options().

unsigned int ROOT::Math::BaseIntegratorOptions::WKSize ( ) const
inline

size of the workspace

Definition at line 69 of file IntegratorOptions.h.

Referenced by ROOT::Math::AdaptiveIntegratorMultiDim::SetOptions(), and ROOT::Math::GSLIntegrator::SetOptions().

Member Data Documentation

double ROOT::Math::BaseIntegratorOptions::fAbsTolerance
protected

Definition at line 99 of file IntegratorOptions.h.

Referenced by AbsTolerance(), ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions(), operator=(), and SetAbsTolerance().

ROOT::Math::IOptions* ROOT::Math::BaseIntegratorOptions::fExtraOptions
protected

Definition at line 104 of file IntegratorOptions.h.

Referenced by ClearExtra(), ExtraOptions(), ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions(), operator=(), and SetExtraOptions().

int ROOT::Math::BaseIntegratorOptions::fIntegType
protected

Definition at line 95 of file IntegratorOptions.h.

Referenced by ROOT::Math::IntegratorOneDimOptions::Integrator(), ROOT::Math::IntegratorMultiDimOptions::Integrator(), ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorType(), ROOT::Math::IntegratorMultiDimOptions::IntegratorType(), operator=(), ROOT::Math::IntegratorOneDimOptions::SetIntegrator(), and ROOT::Math::IntegratorMultiDimOptions::SetIntegrator().

unsigned int ROOT::Math::BaseIntegratorOptions::fNCalls
protected

Definition at line 98 of file IntegratorOptions.h.

Referenced by ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions(), ROOT::Math::IntegratorMultiDimOptions::NCalls(), ROOT::Math::IntegratorOneDimOptions::NPoints(), operator=(), ROOT::Math::IntegratorMultiDimOptions::SetNCalls(), and ROOT::Math::IntegratorOneDimOptions::SetNPoints().

double ROOT::Math::BaseIntegratorOptions::fRelTolerance
protected

Definition at line 100 of file IntegratorOptions.h.

Referenced by ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions(), operator=(), RelTolerance(), and SetRelTolerance().

unsigned int ROOT::Math::BaseIntegratorOptions::fWKSize
protected

Definition at line 97 of file IntegratorOptions.h.

Referenced by ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions(), ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions(), operator=(), SetWKSize(), and WKSize().

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