class ROOT::Math::IntegratorMultiDimOptions

library: libMathCore
#include "Math/IntegratorOptions.h"

Display options:

[ ↑ Top ] | [ ? Help ]

Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file viewVC header

Sections: class description function members data members class charts

ROOT » MATH » MATHCORE » ROOT::Math::IntegratorMultiDimOptions

class ROOT::Math::IntegratorMultiDimOptions: public ROOT::Math::BaseIntegratorOptions

    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

    @ingroup Integration

Function Members (Methods)

public:

virtual	~IntegratorMultiDimOptions()
double	ROOT::Math::BaseIntegratorOptions::AbsTolerance() const
static ROOT::Math::IOptions&	Default(const char* name)
static double	DefaultAbsTolerance()
static string	DefaultIntegrator()
static ROOT::Math::IntegrationMultiDim::Type	DefaultIntegratorType()
static unsigned int	DefaultNCalls()
static double	DefaultRelTolerance()
static unsigned int	DefaultWKSize()
ROOT::Math::IOptions*	ROOT::Math::BaseIntegratorOptions::ExtraOptions() const
static ROOT::Math::IOptions*	FindDefault(const char* name)
virtual string	Integrator() const
ROOT::Math::IntegratorMultiDimOptions	IntegratorMultiDimOptions(ROOT::Math::IOptions* extraOpts = 0)
ROOT::Math::IntegratorMultiDimOptions	IntegratorMultiDimOptions(const ROOT::Math::IntegratorMultiDimOptions& rhs)
ROOT::Math::IntegrationMultiDim::Type	IntegratorType() const
unsigned int	NCalls() const
ROOT::Math::IntegratorMultiDimOptions&	operator=(const ROOT::Math::IntegratorMultiDimOptions& rhs)
void	Print(ostream& os = std::cout) const
static void	PrintDefault(const char* name = 0, ostream& os = std::cout)
double	ROOT::Math::BaseIntegratorOptions::RelTolerance() const
void	ROOT::Math::BaseIntegratorOptions::SetAbsTolerance(double tol)
static void	SetDefaultAbsTolerance(double tol)
static void	SetDefaultIntegrator(const char* name)
static void	SetDefaultNCalls(unsigned int ncall)
static void	SetDefaultRelTolerance(double tol)
static void	SetDefaultWKSize(unsigned int size)
void	ROOT::Math::BaseIntegratorOptions::SetExtraOptions(const ROOT::Math::IOptions& opt)
void	SetIntegrator(const char* name)
void	SetNCalls(unsigned int calls)
void	ROOT::Math::BaseIntegratorOptions::SetRelTolerance(double tol)
void	ROOT::Math::BaseIntegratorOptions::SetWKSize(unsigned int size)
unsigned int	ROOT::Math::BaseIntegratorOptions::WKSize() const

protected:

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

Data Members

protected:

double	ROOT::Math::BaseIntegratorOptions::fAbsTolerance	absolute tolerance
ROOT::Math::IOptions*	ROOT::Math::BaseIntegratorOptions::fExtraOptions	extra options
int	ROOT::Math::BaseIntegratorOptions::fIntegType	Integrator type (value converted from enum)
unsigned int	ROOT::Math::BaseIntegratorOptions::fNCalls	(max) funxtion calls
double	ROOT::Math::BaseIntegratorOptions::fRelTolerance	relative tolerance
unsigned int	ROOT::Math::BaseIntegratorOptions::fWKSize	workspace size

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

BaseIntegratorOptions & operator=(const ROOT::Math::IntegratorMultiDimOptions& rhs)

 assignment operators

std::string Integrator() const

 name of 1D integrator

IntegrationOneDim::Type IntegratorType() const

 type of the integrator (return the enumeration type)

{ return (IntegrationOneDim::Type) fIntegType; }

void SetIntegrator(const char* name)

 set 1D integrator name

void Print(ostream& os = std::cout) const

 print all the options

void SetDefaultIntegrator(const char* name)

 static methods for setting and retrieving the default options

void SetDefaultAbsTolerance(double tol)

void SetDefaultRelTolerance(double tol)

void SetDefaultWKSize(unsigned int size)

std::string DefaultIntegrator()

IntegrationOneDim::Type DefaultIntegratorType()

double DefaultAbsTolerance()

double DefaultRelTolerance()

unsigned int DefaultWKSize()

ROOT::Math::IOptions & Default(const char* name)

 retrieve specific options - if not existing create a IOptions

ROOT::Math::IOptions * FindDefault(const char* name)

 find specific options - return 0 if not existing

void PrintDefault(const char* name = 0, ostream& os = std::cout)

 print only the specified default options

IntegratorMultiDimOptions(IOptions * extraOpts = 0)

 constructor using the default options
 can pass a pointer to extra options (N.B. pointer will be managed by the class)

virtual ~IntegratorMultiDimOptions()

{}

IntegratorMultiDimOptions(const IntegratorMultiDimOptions & rhs)

 copy constructor

{}

void SetNCalls(unsigned int calls)

 specific method for multi-dim
 set maximum number of function calls

{ fNCalls = calls; }

unsigned int NCalls() const

 maximum number of function calls

{ return fNCalls; }

void SetDefaultNCalls(unsigned int ncall)

unsigned int DefaultNCalls()