Logo ROOT  

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

Numerical multi dimensional integration options.

Definition at line 194 of file IntegratorOptions.h.

Public Member Functions

 IntegratorMultiDimOptions (const IntegratorMultiDimOptions &rhs)
 copy constructor
 IntegratorMultiDimOptions (IOptions *extraOpts=nullptr)
 constructor using the default options can pass a pointer to extra options (N.B.
 ~IntegratorMultiDimOptions () override
double AbsTolerance () const
 non-static methods for retrieving options
IOptions * ExtraOptions () const
 return extra options
std::string Integrator () const override
 name of multi-dim integrator
IntegrationMultiDim::Type IntegratorType () const
 type of the integrator (return the enumeration type)
unsigned int NCalls () const
 maximum number of function calls
IntegratorMultiDimOptions & operator= (const IntegratorMultiDimOptions &rhs)
 assignment operator
void Print (std::ostream &os=std::cout) const
 print all the options
double RelTolerance () const
 absolute tolerance
void SetAbsTolerance (double tol)
 non-static methods for setting options
void SetExtraOptions (const IOptions &opt)
 set extra options (in this case pointer is cloned)
void SetIntegrator (const char *name)
 set multi-dim integrator name
void SetNCalls (unsigned int calls)
 set maximum number of function calls
void SetRelTolerance (double tol)
 set the relative tolerance
void SetWKSize (unsigned int size)
 set workspace size
unsigned int WKSize () const
 size of the workspace

Static Public Member Functions

static ROOT::Math::IOptions & Default (const char *name)
 retrieve specific options
static double DefaultAbsTolerance ()
static std::string DefaultIntegrator ()
static IntegrationMultiDim::Type DefaultIntegratorType ()
static unsigned int DefaultNCalls ()
static double DefaultRelTolerance ()
static unsigned int DefaultWKSize ()
static ROOT::Math::IOptions * FindDefault (const char *name)
 find specific options - return 0 if not existing
static void PrintDefault (const char *name=nullptr, std::ostream &os=std::cout)
 print only the specified default options
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)

Protected Member Functions

void ClearExtra ()

Protected Attributes

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

#include <Math/IntegratorOptions.h>

Inheritance diagram for ROOT::Math::IntegratorMultiDimOptions:
ROOT::Math::BaseIntegratorOptions

Constructor & Destructor Documentation

◆ IntegratorMultiDimOptions() [1/2]

ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions ( IOptions * extraOpts = nullptr)

constructor using the default options can pass a pointer to extra options (N.B.

pointer will be managed by the class)

Definition at line 285 of file IntegratorOptions.cxx.

◆ ~IntegratorMultiDimOptions()

ROOT::Math::IntegratorMultiDimOptions::~IntegratorMultiDimOptions ( )
inlineoverride

Definition at line 203 of file IntegratorOptions.h.

◆ IntegratorMultiDimOptions() [2/2]

ROOT::Math::IntegratorMultiDimOptions::IntegratorMultiDimOptions ( const IntegratorMultiDimOptions & rhs)
inline

copy constructor

Definition at line 206 of file IntegratorOptions.h.

Member Function Documentation

◆ AbsTolerance()

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

non-static methods for retrieving options

absolute tolerance

Definition at line 61 of file IntegratorOptions.h.

◆ ClearExtra()

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

Definition at line 161 of file IntegratorOptions.cxx.

◆ Default()

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

retrieve specific options

Definition at line 373 of file IntegratorOptions.cxx.

◆ DefaultAbsTolerance()

double ROOT::Math::IntegratorMultiDimOptions::DefaultAbsTolerance ( )
static

Definition at line 367 of file IntegratorOptions.cxx.

◆ DefaultIntegrator()

std::string ROOT::Math::IntegratorMultiDimOptions::DefaultIntegrator ( )
static

Definition at line 336 of file IntegratorOptions.cxx.

◆ DefaultIntegratorType()

IntegratorMultiDim::Type ROOT::Math::IntegratorMultiDimOptions::DefaultIntegratorType ( )
static

Definition at line 341 of file IntegratorOptions.cxx.

◆ DefaultNCalls()

unsigned int ROOT::Math::IntegratorMultiDimOptions::DefaultNCalls ( )
static

Definition at line 370 of file IntegratorOptions.cxx.

◆ DefaultRelTolerance()

double ROOT::Math::IntegratorMultiDimOptions::DefaultRelTolerance ( )
static

Definition at line 368 of file IntegratorOptions.cxx.

◆ DefaultWKSize()

unsigned int ROOT::Math::IntegratorMultiDimOptions::DefaultWKSize ( )
static

Definition at line 369 of file IntegratorOptions.cxx.

◆ ExtraOptions()

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

return extra options

Definition at line 71 of file IntegratorOptions.h.

◆ FindDefault()

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

find specific options - return 0 if not existing

Definition at line 378 of file IntegratorOptions.cxx.

◆ Integrator()

std::string ROOT::Math::IntegratorMultiDimOptions::Integrator ( ) const
overridevirtual

name of multi-dim integrator

Implements ROOT::Math::BaseIntegratorOptions.

Definition at line 308 of file IntegratorOptions.cxx.

◆ IntegratorType()

IntegrationMultiDim::Type ROOT::Math::IntegratorMultiDimOptions::IntegratorType ( ) const
inline

type of the integrator (return the enumeration type)

Definition at line 228 of file IntegratorOptions.h.

◆ NCalls()

unsigned int ROOT::Math::IntegratorMultiDimOptions::NCalls ( ) const
inline

maximum number of function calls

Definition at line 222 of file IntegratorOptions.h.

◆ operator=()

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

assignment operator

Definition at line 211 of file IntegratorOptions.h.

◆ Print()

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

print all the options

Definition at line 312 of file IntegratorOptions.cxx.

◆ PrintDefault()

void ROOT::Math::IntegratorMultiDimOptions::PrintDefault ( const char * name = nullptr,
std::ostream & os = std::cout )
static

print only the specified default options

print default options

Definition at line 320 of file IntegratorOptions.cxx.

◆ RelTolerance()

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

absolute tolerance

Definition at line 64 of file IntegratorOptions.h.

◆ SetAbsTolerance()

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

non-static methods for setting options

set the abs tolerance

Definition at line 77 of file IntegratorOptions.h.

◆ SetDefaultAbsTolerance()

void ROOT::Math::IntegratorMultiDimOptions::SetDefaultAbsTolerance ( double tol)
static

Definition at line 347 of file IntegratorOptions.cxx.

◆ SetDefaultIntegrator()

void ROOT::Math::IntegratorMultiDimOptions::SetDefaultIntegrator ( const char * name)
static

Definition at line 326 of file IntegratorOptions.cxx.

◆ SetDefaultNCalls()

void ROOT::Math::IntegratorMultiDimOptions::SetDefaultNCalls ( unsigned int ncall)
static

Definition at line 361 of file IntegratorOptions.cxx.

◆ SetDefaultRelTolerance()

void ROOT::Math::IntegratorMultiDimOptions::SetDefaultRelTolerance ( double tol)
static

Definition at line 352 of file IntegratorOptions.cxx.

◆ SetDefaultWKSize()

void ROOT::Math::IntegratorMultiDimOptions::SetDefaultWKSize ( unsigned int size)
static

Definition at line 357 of file IntegratorOptions.cxx.

◆ SetExtraOptions()

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

set extra options (in this case pointer is cloned)

Definition at line 167 of file IntegratorOptions.cxx.

◆ SetIntegrator()

void ROOT::Math::IntegratorMultiDimOptions::SetIntegrator ( const char * name)

set multi-dim integrator name

Definition at line 302 of file IntegratorOptions.cxx.

◆ SetNCalls()

void ROOT::Math::IntegratorMultiDimOptions::SetNCalls ( unsigned int calls)
inline

set maximum number of function calls

Definition at line 219 of file IntegratorOptions.h.

◆ SetRelTolerance()

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

set the relative tolerance

Definition at line 80 of file IntegratorOptions.h.

◆ SetWKSize()

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

set workspace size

Definition at line 83 of file IntegratorOptions.h.

◆ WKSize()

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

size of the workspace

Definition at line 67 of file IntegratorOptions.h.

Member Data Documentation

◆ fAbsTolerance

double ROOT::Math::BaseIntegratorOptions::fAbsTolerance
protectedinherited

absolute tolerance

Definition at line 97 of file IntegratorOptions.h.

◆ fExtraOptions

ROOT::Math::IOptions* ROOT::Math::BaseIntegratorOptions::fExtraOptions
protectedinherited

Definition at line 102 of file IntegratorOptions.h.

◆ fIntegType

int ROOT::Math::BaseIntegratorOptions::fIntegType
protectedinherited

Integrator type (value converted from enum).

Definition at line 93 of file IntegratorOptions.h.

◆ fNCalls

unsigned int ROOT::Math::BaseIntegratorOptions::fNCalls
protectedinherited

(max) function calls

Definition at line 96 of file IntegratorOptions.h.

◆ fRelTolerance

double ROOT::Math::BaseIntegratorOptions::fRelTolerance
protectedinherited

relative tolerance

Definition at line 98 of file IntegratorOptions.h.

◆ fWKSize

unsigned int ROOT::Math::BaseIntegratorOptions::fWKSize
protectedinherited

workspace size

Definition at line 95 of file IntegratorOptions.h.

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