Logo ROOT  
Reference Guide
No Matches
ROOT::Math::IntegratorMultiDimOptions Class Reference

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
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
IntegratorMultiDimOptionsoperator= (const IntegratorMultiDimOptions &rhs)
 assignment operator
void Print (std::ostream &os=std::cout) const
 print all the options
void SetIntegrator (const char *name)
 set multi-dim integrator name
void SetNCalls (unsigned int calls)
 set maximum number of function calls
- Public Member Functions inherited from ROOT::Math::BaseIntegratorOptions
 BaseIntegratorOptions (const BaseIntegratorOptions &opt)
virtual ~BaseIntegratorOptions ()
 protected constructor to avoid user creating this class
double AbsTolerance () const
 non-static methods for retrieving options
IOptionsExtraOptions () const
 return extra options
BaseIntegratorOptionsoperator= (const BaseIntegratorOptions &opt)
 assignment operators
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 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::IOptionsDefault (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::IOptionsFindDefault (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)

Additional Inherited Members

- Protected Member Functions inherited from ROOT::Math::BaseIntegratorOptions
 BaseIntegratorOptions ()
 protected constructor to avoid user creating this class
void ClearExtra ()
- Protected Attributes inherited from ROOT::Math::BaseIntegratorOptions
double fAbsTolerance
 absolute tolerance
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:

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 286 of file IntegratorOptions.cxx.

◆ ~IntegratorMultiDimOptions()

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

Definition at line 203 of file IntegratorOptions.h.

◆ IntegratorMultiDimOptions() [2/2]

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

copy constructor

Definition at line 206 of file IntegratorOptions.h.

Member Function Documentation

◆ Default()

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

retrieve specific options

Definition at line 375 of file IntegratorOptions.cxx.

◆ DefaultAbsTolerance()

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

Definition at line 369 of file IntegratorOptions.cxx.

◆ DefaultIntegrator()

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

Definition at line 338 of file IntegratorOptions.cxx.

◆ DefaultIntegratorType()

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

Definition at line 343 of file IntegratorOptions.cxx.

◆ DefaultNCalls()

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

Definition at line 372 of file IntegratorOptions.cxx.

◆ DefaultRelTolerance()

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

Definition at line 370 of file IntegratorOptions.cxx.

◆ DefaultWKSize()

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

Definition at line 371 of file IntegratorOptions.cxx.

◆ FindDefault()

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

find specific options - return 0 if not existing

Definition at line 380 of file IntegratorOptions.cxx.

◆ Integrator()

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

name of multi-dim integrator

Implements ROOT::Math::BaseIntegratorOptions.

Definition at line 310 of file IntegratorOptions.cxx.

◆ IntegratorType()

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

type of the integrator (return the enumeration type)

Definition at line 228 of file IntegratorOptions.h.

◆ NCalls()

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

maximum number of function calls

Definition at line 222 of file IntegratorOptions.h.

◆ operator=()

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

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 314 of file IntegratorOptions.cxx.

◆ PrintDefault()

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

print only the specified default options

print default options

Definition at line 322 of file IntegratorOptions.cxx.

◆ SetDefaultAbsTolerance()

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

Definition at line 349 of file IntegratorOptions.cxx.

◆ SetDefaultIntegrator()

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

Definition at line 328 of file IntegratorOptions.cxx.

◆ SetDefaultNCalls()

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

Definition at line 363 of file IntegratorOptions.cxx.

◆ SetDefaultRelTolerance()

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

Definition at line 354 of file IntegratorOptions.cxx.

◆ SetDefaultWKSize()

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

Definition at line 359 of file IntegratorOptions.cxx.

◆ SetIntegrator()

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

set multi-dim integrator name

Definition at line 304 of file IntegratorOptions.cxx.

◆ SetNCalls()

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

set maximum number of function calls

Definition at line 219 of file IntegratorOptions.h.

Libraries for ROOT::Math::IntegratorMultiDimOptions:

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