Logo ROOT  
Reference Guide
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 41 of file FCNAdapter.h.

Public Member Functions

 FCNAdapter (const Function &f, double up=1.)
 
 ~FCNAdapter ()
 
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. More...
 
void SetErrorDef (double up)
 add interface to set dynamically a new error definition Re-implement this function if needed. More...
 
double Up () const
 Error definition of the function. More...
 
- Public Member Functions inherited from ROOT::Minuit2::FCNBase
virtual ~FCNBase ()
 
virtual double ErrorDef () const
 Error definition of the function. More...
 
- Public Member Functions inherited from ROOT::Minuit2::GenericFunction
virtual ~GenericFunction ()
 

Private Attributes

const FunctionfFunc
 
double fUp
 

#include <Minuit2/FCNAdapter.h>

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

Constructor & Destructor Documentation

◆ FCNAdapter()

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

Definition at line 49 of file FCNAdapter.h.

◆ ~FCNAdapter()

template<class Function >
ROOT::Minuit2::FCNAdapter< Function >::~FCNAdapter ( )
inline

Definition at line 54 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 60 of file FCNAdapter.h.

◆ operator()() [2/2]

template<class Function >
double ROOT::Minuit2::FCNAdapter< 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
parfunction parameters as defined by the user.
Returns
the Value of the function.
See also
MnUserParameters
VariableMetricMinimizer
MnMigrad

Implements ROOT::Minuit2::FCNBase.

Definition at line 57 of file FCNAdapter.h.

◆ SetErrorDef()

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

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

Reimplemented from ROOT::Minuit2::FCNBase.

Definition at line 65 of file FCNAdapter.h.

◆ Up()

template<class Function >
double ROOT::Minuit2::FCNAdapter< 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 63 of file FCNAdapter.h.

Member Data Documentation

◆ fFunc

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

Definition at line 73 of file FCNAdapter.h.

◆ fUp

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

Definition at line 74 of file FCNAdapter.h.


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