ROOT::Minuit2::FCNGradAdapter< Function > Class Template Reference

template<class Function>
class ROOT::Minuit2::FCNGradAdapter< Function >

template wrapped class for adapting to FCNBase signature a IGradFunction

Author

Lorenzo Moneta

Definition at line 34 of file FCNGradAdapter.h.

Public Member Functions
	FCNGradAdapter (const Function &f, double up=1.)
	~FCNGradAdapter ()
bool	CheckGradient () const
std::vector< double >	Gradient (const std::vector< double > &v) const
double	operator() (const double *v) const
double	operator() (const std::vector< double > &v) const
	The meaning of the vector of parameters is of course defined by the user, who uses the values of those parameters to calculate their function Value.
double	Up () const
	Error definition of the function.
Public Member Functions inherited from ROOT::Minuit2::FCNGradientBase
virtual	~FCNGradientBase ()
Public Member Functions inherited from ROOT::Minuit2::FCNBase
virtual	~FCNBase ()
virtual double	ErrorDef () const
	Error definition of the function.
virtual void	SetErrorDef (double)
	add interface to set dynamically a new error definition Re-implement this function if needed.
Public Member Functions inherited from ROOT::Minuit2::GenericFunction
virtual	~GenericFunction ()

Private Attributes
const Function &	fFunc
std::vector< double >	fGrad
double	fUp

#include <Minuit2/FCNGradAdapter.h>

Inheritance diagram for ROOT::Minuit2::FCNGradAdapter< Function >:

Constructor & Destructor Documentation

FCNGradAdapter()

template<class Function >

ROOT::Minuit2::FCNGradAdapter< Function >::FCNGradAdapter ( const Function &  f, double  up = 1.  )

inline

Definition at line 37 of file FCNGradAdapter.h.

~FCNGradAdapter()

template<class Function >

ROOT::Minuit2::FCNGradAdapter< Function >::~FCNGradAdapter ( )

inline

Definition at line 39 of file FCNGradAdapter.h.

Member Function Documentation

CheckGradient()

template<class Function >

bool ROOT::Minuit2::FCNGradAdapter< Function >::CheckGradient ( ) const

inlinevirtual

Reimplemented from ROOT::Minuit2::FCNGradientBase.

Definition at line 59 of file FCNGradAdapter.h.

Gradient()

template<class Function >

std::vector< double > ROOT::Minuit2::FCNGradAdapter< Function >::Gradient ( const std::vector< double > &  v ) const

inlinevirtual

Implements ROOT::Minuit2::FCNGradientBase.

Definition at line 46 of file FCNGradAdapter.h.

operator()() [1/2]

template<class Function >

double ROOT::Minuit2::FCNGradAdapter< Function >::operator() ( const double *  v ) const

inline

Definition at line 42 of file FCNGradAdapter.h.

operator()() [2/2]

template<class Function >

double ROOT::Minuit2::FCNGradAdapter< Function >::operator() ( const std::vector< double > &  v ) const

inlinevirtual

The meaning of the vector of parameters is of course defined by the user, who uses the values of those parameters to calculate their function Value.

The order and the position of these parameters is strictly the one specified by the user when supplying the starting values for minimization. The starting values must be specified by the user, either via an std::vector<double> or the MnUserParameters supplied as input to the MINUIT minimizers such as VariableMetricMinimizer or MnMigrad. Later values are determined by MINUIT as it searches for the Minimum or performs whatever analysis is requested by the user.

Parameters

v	function parameters as defined by the user.

Returns

the Value of the function.

See also

MnUserParameters

VariableMetricMinimizer

MnMigrad

Implements ROOT::Minuit2::FCNBase.

Definition at line 41 of file FCNGradAdapter.h.

Up()

template<class Function >

double ROOT::Minuit2::FCNGradAdapter< Function >::Up ( ) const

inlinevirtual

Error definition of the function.

MINUIT defines Parameter errors as the change in Parameter Value required to change the function Value by up. Normally, for chisquared fits it is 1, and for negative log likelihood, its Value is 0.5. If the user wants instead the 2-sigma errors for chisquared fits, it becomes 4, as Chi2(x+n*sigma) = Chi2(x) + n*n.

Implements ROOT::Minuit2::FCNBase.

Definition at line 44 of file FCNGradAdapter.h.

Member Data Documentation

fFunc

template<class Function >

const Function& ROOT::Minuit2::FCNGradAdapter< Function >::fFunc

private

Definition at line 62 of file FCNGradAdapter.h.

fGrad

template<class Function >

std::vector<double> ROOT::Minuit2::FCNGradAdapter< Function >::fGrad

mutableprivate

Definition at line 64 of file FCNGradAdapter.h.

fUp

template<class Function >

double ROOT::Minuit2::FCNGradAdapter< Function >::fUp

private

Definition at line 63 of file FCNGradAdapter.h.