ROOT  6.06/09
Reference Guide
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ROOT::Math::MinimizerOptions Class Reference

Minimizer options.

Definition at line 32 of file MinimizerOptions.h.

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

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

#include <Math/MinimizerOptions.h>

+ Collaboration diagram for ROOT::Math::MinimizerOptions:

Constructor & Destructor Documentation

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

Definition at line 109 of file MinimizerOptions.cxx.

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

Definition at line 142 of file MinimizerOptions.cxx.

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

Definition at line 118 of file MinimizerOptions.cxx.

Member Function Documentation

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

retrieve extra options - if not existing create a IOptions

Definition at line 203 of file MinimizerOptions.cxx.

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

Definition at line 88 of file MinimizerOptions.cxx.

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

Definition at line 84 of file MinimizerOptions.cxx.

Referenced by TVirtualFitter::GetMaxIterations().

int ROOT::Math::MinimizerOptions::DefaultMaxIterations ( )
static
const std::string & ROOT::Math::MinimizerOptions::DefaultMinimizerAlgo ( )
static
const std::string & ROOT::Math::MinimizerOptions::DefaultMinimizerType ( )
static
double ROOT::Math::MinimizerOptions::DefaultPrecision ( )
static

Definition at line 83 of file MinimizerOptions.cxx.

int ROOT::Math::MinimizerOptions::DefaultPrintLevel ( )
static
int ROOT::Math::MinimizerOptions::DefaultStrategy ( )
static
double ROOT::Math::MinimizerOptions::DefaultTolerance ( )
static
double ROOT::Math::MinimizerOptions::ErrorDef ( ) const
inline
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.

Referenced by Print(), PrintDefault(), and ROOT::Math::GeneticMinimizer::SetOptions().

IOptions * ROOT::Math::MinimizerOptions::FindDefault ( const char *  name)
static
unsigned int ROOT::Math::MinimizerOptions::MaxFunctionCalls ( ) const
inline

max number of function calls

Definition at line 88 of file MinimizerOptions.h.

Referenced by ROOT::Fit::FitConfig::CreateMinimizer(), and ROOT::Math::Minimizer::MaxFunctionCalls().

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

type of algorithm

Definition at line 112 of file MinimizerOptions.h.

Referenced by ROOT::Fit::FitConfig::CreateMinimizer(), and ROOT::Fit::FitConfig::MinimizerAlgoType().

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

type of minimizer

Definition at line 109 of file MinimizerOptions.h.

Referenced by ROOT::Fit::FitConfig::CreateMinimizer(), and ROOT::Fit::FitConfig::MinimizerType().

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

assignment operators

Definition at line 123 of file MinimizerOptions.cxx.

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.

Referenced by ROOT::Fit::FitConfig::CreateMinimizer(), and ROOT::Math::Minimizer::Precision().

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

print all the options

Definition at line 185 of file MinimizerOptions.cxx.

Referenced by 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 213 of file MinimizerOptions.cxx.

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

non-static methods for setting options

Definition at line 146 of file MinimizerOptions.cxx.

Referenced by MinimizerOptions(), and ROOT::Math::Minimizer::SetDefaultOptions().

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

Definition at line 46 of file MinimizerOptions.cxx.

Referenced by TVirtualFitter::SetErrorDef().

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

Definition at line 74 of file MinimizerOptions.cxx.

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

Definition at line 58 of file MinimizerOptions.cxx.

Referenced by TVirtualFitter::SetMaxIterations().

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

Definition at line 62 of file MinimizerOptions.cxx.

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

Definition at line 54 of file MinimizerOptions.cxx.

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

Definition at line 70 of file MinimizerOptions.cxx.

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

Definition at line 66 of file MinimizerOptions.cxx.

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

Definition at line 50 of file MinimizerOptions.cxx.

Referenced by TVirtualFitter::SetPrecision().

void ROOT::Math::MinimizerOptions::SetErrorDef ( double  err)
inline
void ROOT::Math::MinimizerOptions::SetExtraOptions ( const IOptions opt)

set extra options (in this case pointer is cloned)

Definition at line 179 of file MinimizerOptions.cxx.

Referenced by ROOT::Math::GeneticMinimizer::GeneticMinimizer(), and ROOT::Math::GeneticMinimizer::GetGeneticOptions().

void ROOT::Math::MinimizerOptions::SetMaxFunctionCalls ( unsigned int  maxfcn)
inline
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.

Referenced by ROOT::Math::GeneticMinimizer::GetGeneticOptions(), TFitEditor::RetrieveOptions(), and ROOT::Math::Minimizer::SetMaxIterations().

void ROOT::Math::MinimizerOptions::SetMinimizerAlgorithm ( const char *  type)
inline
void ROOT::Math::MinimizerOptions::SetMinimizerType ( const char *  type)
inline
void ROOT::Math::MinimizerOptions::SetPrecision ( double  prec)
inline
void ROOT::Math::MinimizerOptions::SetPrintLevel ( int  level)
inline
void ROOT::Math::MinimizerOptions::SetStrategy ( int  stra)
inline
void ROOT::Math::MinimizerOptions::SetTolerance ( double  tol)
inline
int ROOT::Math::MinimizerOptions::Strategy ( ) const
inline

strategy

Definition at line 94 of file MinimizerOptions.h.

Referenced by ROOT::Fit::FitConfig::CreateMinimizer(), and ROOT::Math::Minimizer::Strategy().

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

Member Data Documentation

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

Definition at line 157 of file MinimizerOptions.h.

Referenced by ErrorDef(), operator=(), Print(), ResetToDefaultOptions(), and SetErrorDef().

ROOT::Math::IOptions* ROOT::Math::MinimizerOptions::fExtraOptions
private
int ROOT::Math::MinimizerOptions::fLevel
private
int ROOT::Math::MinimizerOptions::fMaxCalls
private
int ROOT::Math::MinimizerOptions::fMaxIter
private
std::string ROOT::Math::MinimizerOptions::fMinimType
private
double ROOT::Math::MinimizerOptions::fPrecision
private

Definition at line 159 of file MinimizerOptions.h.

Referenced by operator=(), Precision(), Print(), ResetToDefaultOptions(), and SetPrecision().

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

Definition at line 156 of file MinimizerOptions.h.

Referenced by operator=(), Print(), ResetToDefaultOptions(), SetStrategy(), and Strategy().

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

Definition at line 158 of file MinimizerOptions.h.

Referenced by operator=(), Print(), ResetToDefaultOptions(), SetTolerance(), and Tolerance().


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