Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ROOT::Math::BaseIntegratorOptions Class Referenceabstract
Math » MathCore | Math » 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 35 of file IntegratorOptions.h.

Public Member Functions

 BaseIntegratorOptions (const BaseIntegratorOptions &opt)
 
virtual ~BaseIntegratorOptions ()
 protected constructor to avoid user creating this class
 
double AbsTolerance () const
 non-static methods for retrivieng options
 
IOptions * ExtraOptions () const
 return extra options
 
virtual std::string Integrator () const =0
 name of 1D integrator
 
BaseIntegratorOptions & operator= (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
 

Protected Member Functions

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

Protected Attributes

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

#include <Math/IntegratorOptions.h>

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

Constructor & Destructor Documentation

◆ BaseIntegratorOptions() [1/2]

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.

◆ BaseIntegratorOptions() [2/2]

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

Definition at line 132 of file IntegratorOptions.cxx.

◆ ~BaseIntegratorOptions()

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

protected constructor to avoid user creating this class

Definition at line 52 of file IntegratorOptions.h.

Member Function Documentation

◆ AbsTolerance()

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

non-static methods for retrivieng options

absolute tolerance

Definition at line 61 of file IntegratorOptions.h.

◆ ClearExtra()

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

Definition at line 161 of file IntegratorOptions.cxx.

◆ ExtraOptions()

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

return extra options

Definition at line 71 of file IntegratorOptions.h.

◆ Integrator()

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

name of 1D integrator

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

◆ operator=()

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

assignment operators

Definition at line 137 of file IntegratorOptions.cxx.

◆ RelTolerance()

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

absolute tolerance

Definition at line 64 of file IntegratorOptions.h.

◆ SetAbsTolerance()

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

non-static methods for setting options

set the abs tolerance

Definition at line 77 of file IntegratorOptions.h.

◆ SetExtraOptions()

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.

◆ SetRelTolerance()

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

set the relative tolerance

Definition at line 80 of file IntegratorOptions.h.

◆ SetWKSize()

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

set workspace size

Definition at line 83 of file IntegratorOptions.h.

◆ WKSize()

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

size of the workspace

Definition at line 67 of file IntegratorOptions.h.

Member Data Documentation

◆ fAbsTolerance

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

Definition at line 97 of file IntegratorOptions.h.

◆ fExtraOptions

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

Definition at line 102 of file IntegratorOptions.h.

◆ fIntegType

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

Definition at line 93 of file IntegratorOptions.h.

◆ fNCalls

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

Definition at line 96 of file IntegratorOptions.h.

◆ fRelTolerance

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

Definition at line 98 of file IntegratorOptions.h.

◆ fWKSize

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

Definition at line 95 of file IntegratorOptions.h.

Libraries for ROOT::Math::BaseIntegratorOptions:
[legend]
The documentation for this class was generated from the following files: