Logo ROOT  
Reference Guide
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 () override
 
bool CheckGradient () const override
 
std::vector< doubleGradient (const std::vector< double > &v) const override
 
std::vector< doubleGradientWithPrevResult (const std::vector< double > &v, double *previous_grad, double *previous_g2, double *previous_gstep) const override
 
GradientParameterSpace gradParameterSpace () const override
 
double operator() (const double *v) const
 
double operator() (const std::vector< double > &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. More...
 
double Up () const override
 Error definition of the function. More...
 
- Public Member Functions inherited from ROOT::Minuit2::FCNGradientBase
 ~FCNGradientBase () override
 
virtual bool CheckGradient () const
 
virtual std::vector< doubleGradient (const std::vector< double > &) const =0
 
virtual std::vector< doubleGradientWithPrevResult (const std::vector< double > &parameters, double *, double *, double *) const
 
virtual GradientParameterSpace gradParameterSpace () const
 
- Public Member Functions inherited from ROOT::Minuit2::FCNBase
 ~FCNBase () override
 
virtual double ErrorDef () const
 Error definition of the function. More...
 
double operator() (const std::vector< double > &v) const override=0
 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. More...
 
virtual void SetErrorDef (double)
 add interface to set dynamically a new error definition Re-implement this function if needed. More...
 
virtual double Up () const =0
 Error definition of the function. More...
 
- Public Member Functions inherited from ROOT::Minuit2::GenericFunction
virtual ~GenericFunction ()
 
virtual double operator() (const std::vector< double > &x) const =0
 Evaluates the function using the vector containing the input values. More...
 

Private Attributes

const FunctionfFunc
 
std::vector< doublefGrad
 
double fUp
 

#include <Minuit2/FCNGradAdapter.h>

Inheritance diagram for ROOT::Minuit2::FCNGradAdapter< Function >:
[legend]

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 ( )
inlineoverride

Definition at line 39 of file FCNGradAdapter.h.

Member Function Documentation

◆ CheckGradient()

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

Reimplemented from ROOT::Minuit2::FCNGradientBase.

Definition at line 71 of file FCNGradAdapter.h.

◆ Gradient()

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

Implements ROOT::Minuit2::FCNGradientBase.

Definition at line 46 of file FCNGradAdapter.h.

◆ GradientWithPrevResult()

template<class Function >
std::vector< double > ROOT::Minuit2::FCNGradAdapter< Function >::GradientWithPrevResult ( const std::vector< double > &  v,
double previous_grad,
double previous_g2,
double previous_gstep 
) const
inlineoverridevirtual

Reimplemented from ROOT::Minuit2::FCNGradientBase.

Definition at line 57 of file FCNGradAdapter.h.

◆ gradParameterSpace()

template<class Function >
GradientParameterSpace ROOT::Minuit2::FCNGradAdapter< Function >::gradParameterSpace ( ) const
inlineoverridevirtual

Reimplemented from ROOT::Minuit2::FCNGradientBase.

Definition at line 73 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
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
vfunction 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
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 44 of file FCNGradAdapter.h.

Member Data Documentation

◆ fFunc

template<class Function >
const Function& ROOT::Minuit2::FCNGradAdapter< Function >::fFunc
private

Definition at line 82 of file FCNGradAdapter.h.

◆ fGrad

template<class Function >
std::vector<double> ROOT::Minuit2::FCNGradAdapter< Function >::fGrad
mutableprivate

Definition at line 84 of file FCNGradAdapter.h.

◆ fUp

template<class Function >
double ROOT::Minuit2::FCNGradAdapter< Function >::fUp
private

Definition at line 83 of file FCNGradAdapter.h.


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