ROOT::Math::MinimizerOptions Class Reference

Description

Minimizer options

Definition at line 32 of file MinimizerOptions.h.

Collaboration diagram for ROOT::Math::MinimizerOptions:

Public Member Functions
	MinimizerOptions ()
	MinimizerOptions (const MinimizerOptions &opt)
	~MinimizerOptions ()
double	ErrorDef () const
	error definition More...
const IOptions *	ExtraOptions () const
	return extra options (NULL pointer if they are not present) More...
unsigned int	MaxFunctionCalls () const
	max number of function calls More...
unsigned int	MaxIterations () const
	max iterations More...
const std::string &	MinimizerAlgorithm () const
	type of algorithm More...
const std::string &	MinimizerType () const
	type of minimizer More...
MinimizerOptions &	operator= (const MinimizerOptions &opt)
	assignment operators More...
double	Precision () const
	precision in the objective funciton calculation (value <=0 means left to default) More...
void	Print (std::ostream &os=std::cout) const
	print all the options More...
int	PrintLevel () const
	set print level More...
void	ResetToDefaultOptions ()
void	SetErrorDef (double err)
	set error def More...
void	SetExtraOptions (const IOptions &opt)
	set extra options (in this case pointer is cloned) 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	SetMinimizerAlgorithm (const char *type)
	set minimizer algorithm More...
void	SetMinimizerType (const char *type)
	set minimizer type More...
void	SetPrecision (double prec)
	set the precision More...
void	SetPrintLevel (int level)
	set print level More...
void	SetStrategy (int stra)
	set the strategy More...
void	SetTolerance (double tol)
	set the tolerance More...
int	Strategy () const
	strategy More...
double	Tolerance () const
	absolute tolerance More...

Static Public Member Functions
static ROOT::Math::IOptions &	Default (const char *name)
	retrieve extra options - if not existing create a IOptions More...
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 More...
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

Constructor & Destructor Documentation

MinimizerOptions() [1/2]

ROOT::Math::MinimizerOptions::MinimizerOptions

(

)

~MinimizerOptions()

ROOT::Math::MinimizerOptions::~MinimizerOptions

(

)

MinimizerOptions() [2/2]

ROOT::Math::MinimizerOptions::MinimizerOptions

(

const MinimizerOptions &

opt

)

Member Function Documentation

Default()

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

static

retrieve extra options - if not existing create a IOptions

DefaultErrorDef()

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

static

DefaultExtraOptions()

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

static

DefaultMaxFunctionCalls()

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

static

DefaultMaxIterations()

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

static

DefaultMinimizerAlgo()

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

static

DefaultMinimizerType()

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

static

DefaultPrecision()

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

static

DefaultPrintLevel()

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

static

DefaultStrategy()

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

static

DefaultTolerance()

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

static

ErrorDef()

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

inline

error definition

Definition at line 103 of file MinimizerOptions.h.

{ return  fErrorDef; }

References fErrorDef.

Referenced by ROOT::Math::Minimizer::ErrorDef().

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.

{ return fExtraOptions; }

References fExtraOptions.

FindDefault()

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

static

MaxFunctionCalls()

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

inline

max number of function calls

Definition at line 88 of file MinimizerOptions.h.

{ return fMaxCalls; }

References fMaxCalls.

Referenced by ROOT::Math::Minimizer::MaxFunctionCalls().

MaxIterations()

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

inline

max iterations

Definition at line 91 of file MinimizerOptions.h.

{ return fMaxIter; }

References fMaxIter.

Referenced by ROOT::Math::Minimizer::MaxIterations().

MinimizerAlgorithm()

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

inline

type of algorithm

Definition at line 112 of file MinimizerOptions.h.

{ return fAlgoType; }

References fAlgoType.

Referenced by ROOT::Fit::FitConfig::MinimizerAlgoType().

MinimizerType()

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

inline

type of minimizer

Definition at line 109 of file MinimizerOptions.h.

{ return fMinimType; }

References fMinimType.

Referenced by ROOT::Fit::FitConfig::MinimizerType().

operator=()

MinimizerOptions& ROOT::Math::MinimizerOptions::operator=

(

const MinimizerOptions &

opt

)

assignment operators

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.

{ return  fPrecision; }

References fPrecision.

Referenced by ROOT::Math::Minimizer::Precision().

Print()

void ROOT::Math::MinimizerOptions::Print

(

std::ostream &

os = std::cout

)

const

print all the options

PrintDefault()

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

static

print all the default options for the name given

PrintLevel()

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

inline

set print level

non-static methods for retrieving options

Definition at line 85 of file MinimizerOptions.h.

{ return fLevel; }

References fLevel.

Referenced by ROOT::Math::Minimizer::PrintLevel().

ResetToDefaultOptions()

void ROOT::Math::MinimizerOptions::ResetToDefaultOptions

(

)

non-static methods for setting options

Referenced by ROOT::Math::Minimizer::SetDefaultOptions().

SetDefaultErrorDef()

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

static

SetDefaultExtraOptions()

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

static

SetDefaultMaxFunctionCalls()

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

static

SetDefaultMaxIterations()

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

static

SetDefaultMinimizer()

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

static

SetDefaultPrecision()

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

static

SetDefaultPrintLevel()

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

static

SetDefaultStrategy()

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

static

SetDefaultTolerance()

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

static

SetErrorDef()

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

inline

set error def

Definition at line 139 of file MinimizerOptions.h.

{ fErrorDef = err; }

References fErrorDef.

Referenced by ROOT::Math::Minimizer::SetErrorDef().

SetExtraOptions()

void ROOT::Math::MinimizerOptions::SetExtraOptions

(

const IOptions &

opt

)

set extra options (in this case pointer is cloned)

SetMaxFunctionCalls()

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

inline

set maximum of function calls

Definition at line 124 of file MinimizerOptions.h.

{ fMaxCalls = maxfcn; }

References fMaxCalls.

Referenced by ROOT::Math::Minimizer::SetMaxFunctionCalls().

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.

{ fMaxIter = maxiter; }

References fMaxIter.

Referenced by ROOT::Math::Minimizer::SetMaxIterations().

SetMinimizerAlgorithm()

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

inline

set minimizer algorithm

Definition at line 145 of file MinimizerOptions.h.

{ fAlgoType = type; }

References fAlgoType.

Referenced by ROOT::Fit::FitConfig::SetMinimizer().

SetMinimizerType()

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

inline

set minimizer type

Definition at line 142 of file MinimizerOptions.h.

{ fMinimType = type; }

References fMinimType.

Referenced by ROOT::Fit::FitConfig::SetMinimizer().

SetPrecision()

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

inline

set the precision

Definition at line 133 of file MinimizerOptions.h.

{ fPrecision = prec; }

References fPrecision.

Referenced by ROOT::Math::Minimizer::SetPrecision().

SetPrintLevel()

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

inline

set print level

Definition at line 121 of file MinimizerOptions.h.

{ fLevel = level; }

References fLevel.

Referenced by ROOT::Math::Minimizer::SetPrintLevel().

SetStrategy()

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

inline

set the strategy

Definition at line 136 of file MinimizerOptions.h.

{ fStrategy = stra; }

References fStrategy.

Referenced by ROOT::Math::Minimizer::SetStrategy().

SetTolerance()

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

inline

set the tolerance

Definition at line 130 of file MinimizerOptions.h.

{ fTolerance = tol; }

References fTolerance.

Referenced by ROOT::Math::Minimizer::SetTolerance().

Strategy()

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

inline

strategy

Definition at line 94 of file MinimizerOptions.h.

{ return fStrategy; }

References fStrategy.

Referenced by ROOT::Math::Minimizer::Strategy().

Tolerance()

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

inline

absolute tolerance

Definition at line 97 of file MinimizerOptions.h.

{ return  fTolerance; }

References fTolerance.

Referenced by ROOT::Math::Minimizer::Tolerance().

Member Data Documentation

fAlgoType

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

private

Definition at line 161 of file MinimizerOptions.h.

Referenced by MinimizerAlgorithm(), and SetMinimizerAlgorithm().

fErrorDef

double ROOT::Math::MinimizerOptions::fErrorDef

private

Definition at line 157 of file MinimizerOptions.h.

Referenced by ErrorDef(), and SetErrorDef().

fExtraOptions

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

private

Definition at line 164 of file MinimizerOptions.h.

Referenced by ExtraOptions().

fLevel

int ROOT::Math::MinimizerOptions::fLevel

private

Definition at line 153 of file MinimizerOptions.h.

Referenced by PrintLevel(), and SetPrintLevel().

fMaxCalls

int ROOT::Math::MinimizerOptions::fMaxCalls

private

Definition at line 154 of file MinimizerOptions.h.

Referenced by MaxFunctionCalls(), and SetMaxFunctionCalls().

fMaxIter

int ROOT::Math::MinimizerOptions::fMaxIter

private

Definition at line 155 of file MinimizerOptions.h.

Referenced by MaxIterations(), and SetMaxIterations().

fMinimType

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

private

Definition at line 160 of file MinimizerOptions.h.

Referenced by MinimizerType(), and SetMinimizerType().

fPrecision

double ROOT::Math::MinimizerOptions::fPrecision

private

Definition at line 159 of file MinimizerOptions.h.

Referenced by Precision(), and SetPrecision().

fStrategy

int ROOT::Math::MinimizerOptions::fStrategy

private

Definition at line 156 of file MinimizerOptions.h.

Referenced by SetStrategy(), and Strategy().

fTolerance

double ROOT::Math::MinimizerOptions::fTolerance

private

Definition at line 158 of file MinimizerOptions.h.

Referenced by SetTolerance(), and Tolerance().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/mathcore/Math/MinimizerOptions.h