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

Description

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

template wrapped class for adapting to FCNBase signature a IGradFunction

Author

Lorenzo Moneta

Definition at line 36 of file FCNGradAdapter.h.

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

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

Public Member Functions
	FCNGradAdapter (const Function &f, double up=1.)
	~FCNGradAdapter ()
bool	CheckGradient () const
virtual double	ErrorDef () 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
virtual void	SetErrorDef (double)
double	Up () const

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

Constructor & Destructor Documentation

FCNGradAdapter()

template<class Function >

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

inline

Definition at line 40 of file FCNGradAdapter.h.

                                                      :
      fFunc(f) ,
      fUp (up) ,
      fGrad(std::vector<double>(fFunc.NDim() ) )
 
   {}

~FCNGradAdapter()

template<class Function >

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

inline

Definition at line 47 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 72 of file FCNGradAdapter.h.

{ return false; }

ErrorDef()

virtual double ROOT::Minuit2::FCNBase::ErrorDef ( ) const

inlinevirtualinherited

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.

Comment a little bit better with links!!!!!!!!!!!!!!!!!

Definition at line 93 of file FCNBase.h.

{return Up();}

References ROOT::Minuit2::FCNBase::Up().

Here is the call graph for this function:

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 59 of file FCNGradAdapter.h.

                                                                {
      fFunc.Gradient(&v[0], &fGrad[0]);
 
#ifdef DEBUG
      std::cout << " gradient in FCNAdapter = { " ;
      for (unsigned int i = 0; i < fGrad.size(); ++i)
         std::cout << fGrad[i] << "\t";
      std::cout << "}" << std::endl;
#endif
      return fGrad;
   }

References ROOT::Minuit2::FCNGradAdapter< Function >::fFunc, and ROOT::Minuit2::FCNGradAdapter< Function >::fGrad.

operator()() [1/2]

template<class Function >

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

inline

Definition at line 53 of file FCNGradAdapter.h.

                                              {
      return fFunc.operator()(v);
   }

References ROOT::Minuit2::FCNGradAdapter< Function >::fFunc.

operator()() [2/2]

template<class Function >

double ROOT::Minuit2::FCNGradAdapter< Function >::operator() ( const std::vector< double > &  x ) 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

par	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 50 of file FCNGradAdapter.h.

                                                       {
      return fFunc.operator()(&v[0]);
   }

References ROOT::Minuit2::FCNGradAdapter< Function >::fFunc.

SetErrorDef()

virtual void ROOT::Minuit2::FCNBase::SetErrorDef ( double  )

inlinevirtualinherited

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

Reimplemented in ROOT::Minuit2::FumiliFCNAdapter< Function >, and ROOT::Minuit2::FCNAdapter< Function >.

Definition at line 114 of file FCNBase.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.

Todo:

Comment a little bit better with links!!!!!!!!!!!!!!!!! Idem for ErrorDef()

Implements ROOT::Minuit2::FCNBase.

Definition at line 57 of file FCNGradAdapter.h.

{return fUp;}

References ROOT::Minuit2::FCNGradAdapter< Function >::fUp.

Member Data Documentation

fFunc

template<class Function >

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

private

Definition at line 75 of file FCNGradAdapter.h.

Referenced by ROOT::Minuit2::FCNGradAdapter< Function >::Gradient(), and ROOT::Minuit2::FCNGradAdapter< Function >::operator()().

fGrad

template<class Function >

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

mutableprivate

Definition at line 77 of file FCNGradAdapter.h.

Referenced by ROOT::Minuit2::FCNGradAdapter< Function >::Gradient().

fUp

template<class Function >

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

private

Definition at line 76 of file FCNGradAdapter.h.

Referenced by ROOT::Minuit2::FCNGradAdapter< Function >::Up().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/Minuit2/FCNGradAdapter.h