Logo ROOT  

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

Numerical one dimensional integration options.

Definition at line 113 of file IntegratorOptions.h.

Public Member Functions

 IntegratorOneDimOptions (const IntegratorOneDimOptions &rhs)
 copy constructor
 IntegratorOneDimOptions (IOptions *extraOpts=nullptr)
 constructor using the default options can pass a pointer to extra options (N.B.
 ~IntegratorOneDimOptions () override
double AbsTolerance () const
 non-static methods for retrieving options
IOptions * ExtraOptions () const
 return extra options
std::string Integrator () const override
 name of 1D integrator
IntegrationOneDim::Type IntegratorType () const
 type of the integrator (return the enumeration type)
unsigned int NPoints () const
 Number of points used by current integration rule.
IntegratorOneDimOptions & operator= (const IntegratorOneDimOptions &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 1D integrator name
void SetNPoints (unsigned int n)
 Set number of points for active integration rule.
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 - if not existing create a IOptions
static double DefaultAbsTolerance ()
static std::string DefaultIntegrator ()
static IntegrationOneDim::Type DefaultIntegratorType ()
static unsigned int DefaultNPoints ()
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 SetDefaultNPoints (unsigned int n)
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::IntegratorOneDimOptions:
ROOT::Math::BaseIntegratorOptions

Constructor & Destructor Documentation

◆ IntegratorOneDimOptions() [1/2]

ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions ( 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 179 of file IntegratorOptions.cxx.

◆ ~IntegratorOneDimOptions()

ROOT::Math::IntegratorOneDimOptions::~IntegratorOneDimOptions ( )
inlineoverride

Definition at line 122 of file IntegratorOptions.h.

◆ IntegratorOneDimOptions() [2/2]

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

copy constructor

Definition at line 125 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::IntegratorOneDimOptions::Default ( const char * name)
static

retrieve specific options - if not existing create a IOptions

Definition at line 271 of file IntegratorOptions.cxx.

◆ DefaultAbsTolerance()

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

Definition at line 265 of file IntegratorOptions.cxx.

◆ DefaultIntegrator()

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

Definition at line 235 of file IntegratorOptions.cxx.

◆ DefaultIntegratorType()

IntegratorOneDim::Type ROOT::Math::IntegratorOneDimOptions::DefaultIntegratorType ( )
static

Definition at line 240 of file IntegratorOptions.cxx.

◆ DefaultNPoints()

unsigned int ROOT::Math::IntegratorOneDimOptions::DefaultNPoints ( )
static

Definition at line 268 of file IntegratorOptions.cxx.

◆ DefaultRelTolerance()

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

Definition at line 266 of file IntegratorOptions.cxx.

◆ DefaultWKSize()

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

Definition at line 267 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::IntegratorOneDimOptions::FindDefault ( const char * name)
static

find specific options - return 0 if not existing

Definition at line 276 of file IntegratorOptions.cxx.

◆ Integrator()

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

name of 1D integrator

Implements ROOT::Math::BaseIntegratorOptions.

Definition at line 203 of file IntegratorOptions.cxx.

◆ IntegratorType()

IntegrationOneDim::Type ROOT::Math::IntegratorOneDimOptions::IntegratorType ( ) const
inline

type of the integrator (return the enumeration type)

Definition at line 149 of file IntegratorOptions.h.

◆ NPoints()

unsigned int ROOT::Math::IntegratorOneDimOptions::NPoints ( ) const
inline

Number of points used by current integration rule.

See also
SetNPoints().

Definition at line 143 of file IntegratorOptions.h.

◆ operator=()

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

assignment operator

Definition at line 130 of file IntegratorOptions.h.

◆ Print()

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

print all the options

Definition at line 207 of file IntegratorOptions.cxx.

◆ PrintDefault()

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

print only the specified default options

print default options

Definition at line 215 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::IntegratorOneDimOptions::SetDefaultAbsTolerance ( double tol)
static

Definition at line 246 of file IntegratorOptions.cxx.

◆ SetDefaultIntegrator()

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

Definition at line 222 of file IntegratorOptions.cxx.

◆ SetDefaultNPoints()

void ROOT::Math::IntegratorOneDimOptions::SetDefaultNPoints ( unsigned int n)
static

Definition at line 259 of file IntegratorOptions.cxx.

◆ SetDefaultRelTolerance()

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

Definition at line 250 of file IntegratorOptions.cxx.

◆ SetDefaultWKSize()

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

Definition at line 255 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::IntegratorOneDimOptions::SetIntegrator ( const char * name)

set 1D integrator name

Definition at line 197 of file IntegratorOptions.cxx.

◆ SetNPoints()

void ROOT::Math::IntegratorOneDimOptions::SetNPoints ( unsigned int n)
inline

Set number of points for active integration rule.

  • For the GSL adaptive integrator, n = 1,2,3,4,5,6 correspond to the 15,21,31,41,51,61-point integration rules.
  • For the GaussLegendre integrator, use values > 6, which correspond to the actual number of points being evaluated.

Definition at line 140 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: