ROOT::Math::IntegratorOneDimOptions Class Reference

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
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
void	SetIntegrator (const char *name)
	set 1D integrator name
void	SetNPoints (unsigned int n)
	Set number of points for active integration rule.
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
IOptions *	ExtraOptions () const
	return extra options
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

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)

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
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:

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

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.

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.

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.

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.

Libraries for ROOT::Math::IntegratorOneDimOptions:

---

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

• math/mathcore/inc/Math/IntegratorOptions.h
• math/mathcore/src/IntegratorOptions.cxx