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

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

template wrapped class for adapting to FCNBase signature

Author

Lorenzo Moneta

Definition at line 35 of file FCNAdapter.h.

Public Member Functions
	FCNAdapter (const Function &f, double up=1.)
double	operator() (const double *v) const
double	operator() (std::vector< double > const &v) const override
	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.
void	SetErrorDef (double up) override
	add interface to set dynamically a new error definition Re-implement this function if needed.
double	Up () const override
	Error definition of the function.
Public Member Functions inherited from ROOT::Minuit2::FCNBase
virtual double	ErrorDef () const
	Error definition of the function.
virtual std::vector< double >	G2 (std::vector< double > const &) const
	return second derivatives (diagonal of the Hessian matrix)
virtual std::vector< double >	Gradient (std::vector< double > const &) const
virtual std::vector< double >	GradientWithPrevResult (std::vector< double > const &parameters, double *, double *, double *) const
virtual GradientParameterSpace	gradParameterSpace () const
virtual bool	HasG2 () const
virtual bool	HasGradient () const
virtual bool	HasHessian () const
virtual std::vector< double >	Hessian (std::vector< double > const &) const
	return Hessian
Public Member Functions inherited from ROOT::Minuit2::GenericFunction
virtual	~GenericFunction ()

Private Attributes
const Function &	fFunc
double	fUp

#include <Minuit2/FCNAdapter.h>

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

Constructor & Destructor Documentation

FCNAdapter()

template<class Function >

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

inline

Definition at line 38 of file FCNAdapter.h.

Member Function Documentation

operator()() [1/2]

template<class Function >

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

inline

Definition at line 41 of file FCNAdapter.h.

operator()() [2/2]

template<class Function >

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

inlineoverridevirtual

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 40 of file FCNAdapter.h.

SetErrorDef()

template<class Function >

void ROOT::Minuit2::FCNAdapter< Function >::SetErrorDef ( double  )

inlineoverridevirtual

add interface to set dynamically a new error definition Re-implement this function if needed.

Reimplemented from ROOT::Minuit2::FCNBase.

Definition at line 44 of file FCNAdapter.h.

Up()

template<class Function >

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

inlineoverridevirtual

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 42 of file FCNAdapter.h.

Member Data Documentation

fFunc

template<class Function >

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

private

Definition at line 47 of file FCNAdapter.h.

fUp

template<class Function >

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

private

Definition at line 48 of file FCNAdapter.h.