ROOT  6.06/08
Reference Guide
Public Member Functions | Static Public Member Functions | List of all members
ROOT::Math::IntegratorOneDimOptions Class Reference

Numerical one dimensional integration options.

Definition at line 115 of file IntegratorOptions.h.

Public Member Functions

 IntegratorOneDimOptions (IOptions *extraOpts=0)
 
virtual ~IntegratorOneDimOptions ()
 
 IntegratorOneDimOptions (const IntegratorOneDimOptions &rhs)
 
IntegratorOneDimOptions & operator= (const IntegratorOneDimOptions &rhs)
 
void SetNPoints (unsigned int n)
 set number of points rule values of 1,2,3,4,5,6 corresponds to 15,21,31,41,51,61 and they are used in GSL adaptive values > 6 corresponds to the actual points and they are used by teh GaussLegendre integrator More...
 
unsigned int NPoints () const
 maximum number of function calls More...
 
std::string Integrator () const
 name of 1D integrator More...
 
IntegrationOneDim::Type IntegratorType () const
 type of the integrator (return the enumeration type) More...
 
void SetIntegrator (const char *name)
 set 1D integrator name More...
 
void Print (std::ostream &os=std::cout) const
 print all the options More...
 
- Public Member Functions inherited from ROOT::Math::BaseIntegratorOptions
 BaseIntegratorOptions (const BaseIntegratorOptions &opt)
 
BaseIntegratorOptions & operator= (const BaseIntegratorOptions &opt)
 assignment operators More...
 
virtual ~BaseIntegratorOptions ()
 protected constructor to avoid user creating this class More...
 
double AbsTolerance () const
 non-static methods for retrivieng options More...
 
double RelTolerance () const
 absolute tolerance More...
 
unsigned int WKSize () const
 size of the workspace More...
 
IOptions * ExtraOptions () const
 return extra options More...
 
void SetAbsTolerance (double tol)
 non-static methods for setting options More...
 
void SetRelTolerance (double tol)
 set the relative tolerance More...
 
void SetWKSize (unsigned int size)
 set workspace size More...
 
void SetExtraOptions (const IOptions &opt)
 set extra options (in this case pointer is cloned) More...
 

Static Public Member Functions

static void SetDefaultIntegrator (const char *name)
 
static void SetDefaultAbsTolerance (double tol)
 
static void SetDefaultRelTolerance (double tol)
 
static void SetDefaultWKSize (unsigned int size)
 
static void SetDefaultNPoints (unsigned int n)
 
static std::string DefaultIntegrator ()
 
static IntegrationOneDim::Type DefaultIntegratorType ()
 
static double DefaultAbsTolerance ()
 
static double DefaultRelTolerance ()
 
static unsigned int DefaultWKSize ()
 
static unsigned int DefaultNPoints ()
 
static ROOT::Math::IOptions & Default (const char *name)
 retrieve specific options - if not existing create a IOptions More...
 
static ROOT::Math::IOptions * FindDefault (const char *name)
 
static void PrintDefault (const char *name=0, std::ostream &os=std::cout)
 print only the specified default options More...
 

Additional Inherited Members

- Protected Member Functions inherited from ROOT::Math::BaseIntegratorOptions
 BaseIntegratorOptions ()
 protected constructor to avoid user creating this class More...
 
void ClearExtra ()
 
- Protected Attributes inherited from ROOT::Math::BaseIntegratorOptions
int fIntegType
 
unsigned int fWKSize
 
unsigned int fNCalls
 
double fAbsTolerance
 
double fRelTolerance
 
ROOT::Math::IOptions * fExtraOptions
 

#include <Math/IntegratorOptions.h>

+ Inheritance diagram for ROOT::Math::IntegratorOneDimOptions:
+ Collaboration diagram for ROOT::Math::IntegratorOneDimOptions:

Constructor & Destructor Documentation

§ IntegratorOneDimOptions() [1/2]

ROOT::Math::IntegratorOneDimOptions::IntegratorOneDimOptions ( IOptions *  extraOpts = 0)

Definition at line 179 of file IntegratorOptions.cxx.

§ ~IntegratorOneDimOptions()

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

Definition at line 124 of file IntegratorOptions.h.

§ IntegratorOneDimOptions() [2/2]

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

Definition at line 127 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 272 of file IntegratorOptions.cxx.

§ DefaultAbsTolerance()

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

§ DefaultIntegrator()

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

§ DefaultIntegratorType()

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

§ DefaultNPoints()

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

§ DefaultRelTolerance()

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

§ DefaultWKSize()

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

§ FindDefault()

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

Definition at line 277 of file IntegratorOptions.cxx.

Referenced by IntegratorOneDimOptions().

§ Integrator()

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

name of 1D integrator

Implements ROOT::Math::BaseIntegratorOptions.

Definition at line 204 of file IntegratorOptions.cxx.

Referenced by ROOT::Math::IntegratorOneDim::Name().

§ IntegratorType()

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

type of the integrator (return the enumeration type)

Definition at line 151 of file IntegratorOptions.h.

Referenced by ROOT::Math::GSLIntegrator::SetOptions().

§ NPoints()

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

maximum number of function calls

Definition at line 145 of file IntegratorOptions.h.

Referenced by ROOT::Math::GaussLegendreIntegrator::SetOptions(), and ROOT::Math::GSLIntegrator::SetOptions().

§ operator=()

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

Definition at line 132 of file IntegratorOptions.h.

§ Print()

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

print all the options

Definition at line 208 of file IntegratorOptions.cxx.

§ PrintDefault()

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

print only the specified default options

print default options

Definition at line 216 of file IntegratorOptions.cxx.

§ SetDefaultAbsTolerance()

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

Definition at line 247 of file IntegratorOptions.cxx.

§ SetDefaultIntegrator()

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

Definition at line 223 of file IntegratorOptions.cxx.

§ SetDefaultNPoints()

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

Definition at line 260 of file IntegratorOptions.cxx.

§ SetDefaultRelTolerance()

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

Definition at line 251 of file IntegratorOptions.cxx.

§ SetDefaultWKSize()

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

Definition at line 256 of file IntegratorOptions.cxx.

§ SetIntegrator()

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

§ SetNPoints()

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

set number of points rule values of 1,2,3,4,5,6 corresponds to 15,21,31,41,51,61 and they are used in GSL adaptive values > 6 corresponds to the actual points and they are used by teh GaussLegendre integrator

Definition at line 142 of file IntegratorOptions.h.

Referenced by ROOT::Math::GaussLegendreIntegrator::Options(), ROOT::Math::GaussIntegrator::Options(), and ROOT::Math::GSLIntegrator::Options().


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