Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ROOT::Math::MinimizerOptions Class Reference
Math » MathCore | Math » MathMore » Numerical Algorithms » Multi-dimensional Minimization

Minimizer options.

Definition at line 32 of file MinimizerOptions.h.

Public Member Functions

 MinimizerOptions ()
 
 MinimizerOptions (const MinimizerOptions &opt)
 
 ~MinimizerOptions ()
 
double ErrorDef () const
 error definition
 
const IOptions * ExtraOptions () const
 return extra options (NULL pointer if they are not present)
 
unsigned int MaxFunctionCalls () const
 max number of function calls
 
unsigned int MaxIterations () const
 max iterations
 
const std::string & MinimizerAlgorithm () const
 type of algorithm
 
const std::string & MinimizerType () const
 type of minimizer
 
MinimizerOptions & operator= (const MinimizerOptions &opt)
 assignment operators
 
double Precision () const
 precision in the objective funciton calculation (value <=0 means left to default)
 
void Print (std::ostream &os=std::cout) const
 print all the options
 
int PrintLevel () const
 non-static methods for retrieving options
 
void ResetToDefaultOptions ()
 non-static methods for setting options
 
void SetErrorDef (double err)
 set error def
 
void SetExtraOptions (const IOptions &opt)
 set extra options (in this case pointer is cloned)
 
void SetMaxFunctionCalls (unsigned int maxfcn)
 set maximum of function calls
 
void SetMaxIterations (unsigned int maxiter)
 set maximum iterations (one iteration can have many function calls)
 
void SetMinimizerAlgorithm (const char *type)
 set minimizer algorithm
 
void SetMinimizerType (const char *type)
 set minimizer type
 
void SetPrecision (double prec)
 set the precision
 
void SetPrintLevel (int level)
 set print level
 
void SetStrategy (int stra)
 set the strategy
 
void SetTolerance (double tol)
 set the tolerance
 
int Strategy () const
 strategy
 
double Tolerance () const
 absolute tolerance
 

Static Public Member Functions

static ROOT::Math::IOptions & Default (const char *name)
 retrieve extra options - if not existing create a IOptions
 
static double DefaultErrorDef ()
 
static IOptions * DefaultExtraOptions ()
 
static int DefaultMaxFunctionCalls ()
 
static int DefaultMaxIterations ()
 
static const std::string & DefaultMinimizerAlgo ()
 
static const std::string & DefaultMinimizerType ()
 
static double DefaultPrecision ()
 
static int DefaultPrintLevel ()
 
static int DefaultStrategy ()
 
static double DefaultTolerance ()
 
static ROOT::Math::IOptions * FindDefault (const char *name)
 
static void PrintDefault (const char *name, std::ostream &os=std::cout)
 print all the default options for the name given
 
static void SetDefaultErrorDef (double up)
 
static void SetDefaultExtraOptions (const IOptions *extraoptions)
 
static void SetDefaultMaxFunctionCalls (int maxcall)
 
static void SetDefaultMaxIterations (int maxiter)
 
static void SetDefaultMinimizer (const char *type, const char *algo=0)
 
static void SetDefaultPrecision (double prec)
 
static void SetDefaultPrintLevel (int level)
 
static void SetDefaultStrategy (int strat)
 
static void SetDefaultTolerance (double tol)
 

Private Attributes

std::string fAlgoType
 
double fErrorDef
 
ROOT::Math::IOptions * fExtraOptions
 
int fLevel
 
int fMaxCalls
 
int fMaxIter
 
std::string fMinimType
 
double fPrecision
 
int fStrategy
 
double fTolerance
 

#include <Math/MinimizerOptions.h>

Constructor & Destructor Documentation

◆ MinimizerOptions() [1/2]

ROOT::Math::MinimizerOptions::MinimizerOptions ( )

Definition at line 125 of file MinimizerOptions.cxx.

◆ ~MinimizerOptions()

ROOT::Math::MinimizerOptions::~MinimizerOptions ( )

Definition at line 158 of file MinimizerOptions.cxx.

◆ MinimizerOptions() [2/2]

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

Definition at line 134 of file MinimizerOptions.cxx.

Member Function Documentation

◆ Default()

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

retrieve extra options - if not existing create a IOptions

Definition at line 219 of file MinimizerOptions.cxx.

◆ DefaultErrorDef()

double ROOT::Math::MinimizerOptions::DefaultErrorDef ( )
static

Definition at line 83 of file MinimizerOptions.cxx.

◆ DefaultExtraOptions()

IOptions * ROOT::Math::MinimizerOptions::DefaultExtraOptions ( )
static

Definition at line 90 of file MinimizerOptions.cxx.

◆ DefaultMaxFunctionCalls()

int ROOT::Math::MinimizerOptions::DefaultMaxFunctionCalls ( )
static

Definition at line 86 of file MinimizerOptions.cxx.

◆ DefaultMaxIterations()

int ROOT::Math::MinimizerOptions::DefaultMaxIterations ( )
static

Definition at line 87 of file MinimizerOptions.cxx.

◆ DefaultMinimizerAlgo()

const std::string & ROOT::Math::MinimizerOptions::DefaultMinimizerAlgo ( )
static

Definition at line 82 of file MinimizerOptions.cxx.

◆ DefaultMinimizerType()

const std::string & ROOT::Math::MinimizerOptions::DefaultMinimizerType ( )
static

Definition at line 92 of file MinimizerOptions.cxx.

◆ DefaultPrecision()

double ROOT::Math::MinimizerOptions::DefaultPrecision ( )
static

Definition at line 85 of file MinimizerOptions.cxx.

◆ DefaultPrintLevel()

int ROOT::Math::MinimizerOptions::DefaultPrintLevel ( )
static

Definition at line 89 of file MinimizerOptions.cxx.

◆ DefaultStrategy()

int ROOT::Math::MinimizerOptions::DefaultStrategy ( )
static

Definition at line 88 of file MinimizerOptions.cxx.

◆ DefaultTolerance()

double ROOT::Math::MinimizerOptions::DefaultTolerance ( )
static

Definition at line 84 of file MinimizerOptions.cxx.

◆ ErrorDef()

double ROOT::Math::MinimizerOptions::ErrorDef ( ) const
inline

error definition

Definition at line 103 of file MinimizerOptions.h.

◆ ExtraOptions()

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

return extra options (NULL pointer if they are not present)

Definition at line 106 of file MinimizerOptions.h.

◆ FindDefault()

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

Definition at line 224 of file MinimizerOptions.cxx.

◆ MaxFunctionCalls()

unsigned int ROOT::Math::MinimizerOptions::MaxFunctionCalls ( ) const
inline

max number of function calls

Definition at line 88 of file MinimizerOptions.h.

◆ MaxIterations()

unsigned int ROOT::Math::MinimizerOptions::MaxIterations ( ) const
inline

max iterations

Definition at line 91 of file MinimizerOptions.h.

◆ MinimizerAlgorithm()

const std::string & ROOT::Math::MinimizerOptions::MinimizerAlgorithm ( ) const
inline

type of algorithm

Definition at line 112 of file MinimizerOptions.h.

◆ MinimizerType()

const std::string & ROOT::Math::MinimizerOptions::MinimizerType ( ) const
inline

type of minimizer

Definition at line 109 of file MinimizerOptions.h.

◆ operator=()

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

assignment operators

Definition at line 139 of file MinimizerOptions.cxx.

◆ Precision()

double ROOT::Math::MinimizerOptions::Precision ( ) const
inline

precision in the objective funciton calculation (value <=0 means left to default)

Definition at line 100 of file MinimizerOptions.h.

◆ Print()

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

print all the options

Definition at line 201 of file MinimizerOptions.cxx.

◆ PrintDefault()

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

print all the default options for the name given

Definition at line 229 of file MinimizerOptions.cxx.

◆ PrintLevel()

int ROOT::Math::MinimizerOptions::PrintLevel ( ) const
inline

non-static methods for retrieving options

set print level

Definition at line 85 of file MinimizerOptions.h.

◆ ResetToDefaultOptions()

void ROOT::Math::MinimizerOptions::ResetToDefaultOptions ( )

non-static methods for setting options

Definition at line 162 of file MinimizerOptions.cxx.

◆ SetDefaultErrorDef()

void ROOT::Math::MinimizerOptions::SetDefaultErrorDef ( double  up)
static

Definition at line 48 of file MinimizerOptions.cxx.

◆ SetDefaultExtraOptions()

void ROOT::Math::MinimizerOptions::SetDefaultExtraOptions ( const IOptions *  extraoptions)
static

Definition at line 76 of file MinimizerOptions.cxx.

◆ SetDefaultMaxFunctionCalls()

void ROOT::Math::MinimizerOptions::SetDefaultMaxFunctionCalls ( int  maxcall)
static

Definition at line 60 of file MinimizerOptions.cxx.

◆ SetDefaultMaxIterations()

void ROOT::Math::MinimizerOptions::SetDefaultMaxIterations ( int  maxiter)
static

Definition at line 64 of file MinimizerOptions.cxx.

◆ SetDefaultMinimizer()

void ROOT::Math::MinimizerOptions::SetDefaultMinimizer ( const char *  type,
const char *  algo = 0 
)
static

Definition at line 43 of file MinimizerOptions.cxx.

◆ SetDefaultPrecision()

void ROOT::Math::MinimizerOptions::SetDefaultPrecision ( double  prec)
static

Definition at line 56 of file MinimizerOptions.cxx.

◆ SetDefaultPrintLevel()

void ROOT::Math::MinimizerOptions::SetDefaultPrintLevel ( int  level)
static

Definition at line 72 of file MinimizerOptions.cxx.

◆ SetDefaultStrategy()

void ROOT::Math::MinimizerOptions::SetDefaultStrategy ( int  strat)
static

Definition at line 68 of file MinimizerOptions.cxx.

◆ SetDefaultTolerance()

void ROOT::Math::MinimizerOptions::SetDefaultTolerance ( double  tol)
static

Definition at line 52 of file MinimizerOptions.cxx.

◆ SetErrorDef()

void ROOT::Math::MinimizerOptions::SetErrorDef ( double  err)
inline

set error def

Definition at line 139 of file MinimizerOptions.h.

◆ SetExtraOptions()

void ROOT::Math::MinimizerOptions::SetExtraOptions ( const IOptions &  opt)

set extra options (in this case pointer is cloned)

Definition at line 195 of file MinimizerOptions.cxx.

◆ SetMaxFunctionCalls()

void ROOT::Math::MinimizerOptions::SetMaxFunctionCalls ( unsigned int  maxfcn)
inline

set maximum of function calls

Definition at line 124 of file MinimizerOptions.h.

◆ SetMaxIterations()

void ROOT::Math::MinimizerOptions::SetMaxIterations ( unsigned int  maxiter)
inline

set maximum iterations (one iteration can have many function calls)

Definition at line 127 of file MinimizerOptions.h.

◆ SetMinimizerAlgorithm()

void ROOT::Math::MinimizerOptions::SetMinimizerAlgorithm ( const char *  type)
inline

set minimizer algorithm

Definition at line 145 of file MinimizerOptions.h.

◆ SetMinimizerType()

void ROOT::Math::MinimizerOptions::SetMinimizerType ( const char *  type)
inline

set minimizer type

Definition at line 142 of file MinimizerOptions.h.

◆ SetPrecision()

void ROOT::Math::MinimizerOptions::SetPrecision ( double  prec)
inline

set the precision

Definition at line 133 of file MinimizerOptions.h.

◆ SetPrintLevel()

void ROOT::Math::MinimizerOptions::SetPrintLevel ( int  level)
inline

set print level

Definition at line 121 of file MinimizerOptions.h.

◆ SetStrategy()

void ROOT::Math::MinimizerOptions::SetStrategy ( int  stra)
inline

set the strategy

Definition at line 136 of file MinimizerOptions.h.

◆ SetTolerance()

void ROOT::Math::MinimizerOptions::SetTolerance ( double  tol)
inline

set the tolerance

Definition at line 130 of file MinimizerOptions.h.

◆ Strategy()

int ROOT::Math::MinimizerOptions::Strategy ( ) const
inline

strategy

Definition at line 94 of file MinimizerOptions.h.

◆ Tolerance()

double ROOT::Math::MinimizerOptions::Tolerance ( ) const
inline

absolute tolerance

Definition at line 97 of file MinimizerOptions.h.

Member Data Documentation

◆ fAlgoType

std::string ROOT::Math::MinimizerOptions::fAlgoType
private

Definition at line 161 of file MinimizerOptions.h.

◆ fErrorDef

double ROOT::Math::MinimizerOptions::fErrorDef
private

Definition at line 157 of file MinimizerOptions.h.

◆ fExtraOptions

ROOT::Math::IOptions* ROOT::Math::MinimizerOptions::fExtraOptions
private

Definition at line 164 of file MinimizerOptions.h.

◆ fLevel

int ROOT::Math::MinimizerOptions::fLevel
private

Definition at line 153 of file MinimizerOptions.h.

◆ fMaxCalls

int ROOT::Math::MinimizerOptions::fMaxCalls
private

Definition at line 154 of file MinimizerOptions.h.

◆ fMaxIter

int ROOT::Math::MinimizerOptions::fMaxIter
private

Definition at line 155 of file MinimizerOptions.h.

◆ fMinimType

std::string ROOT::Math::MinimizerOptions::fMinimType
private

Definition at line 160 of file MinimizerOptions.h.

◆ fPrecision

double ROOT::Math::MinimizerOptions::fPrecision
private

Definition at line 159 of file MinimizerOptions.h.

◆ fStrategy

int ROOT::Math::MinimizerOptions::fStrategy
private

Definition at line 156 of file MinimizerOptions.h.

◆ fTolerance

double ROOT::Math::MinimizerOptions::fTolerance
private

Definition at line 158 of file MinimizerOptions.h.

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