Logo ROOT  
Reference Guide
ROOT::Math::MinimTransformFunction Class Reference

MinimTransformFunction class to perform a transformations on the variables to deal with fixed or limited variables (support both double and single bounds) The class manages the passed function pointer.

Definition at line 41 of file MinimTransformFunction.h.

Public Types

typedef ROOT::Math::IMultiGradFunction::BaseFunc BaseFunc
 
typedef ROOT::Math::IMultiGradFunction BaseGradFunc
 
- Public Types inherited from ROOT::Math::IGradientFunctionMultiDimTempl< T >
typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 
typedef IGradientMultiDimTempl< T > BaseGrad
 
- Public Types inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
typedef T BackendType
 
typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 

Public Member Functions

 MinimTransformFunction (const IMultiGradFunction *f, const std::vector< ROOT::Math::EMinimVariableType > &types, const std::vector< double > &values, const std::map< unsigned int, std::pair< double, double > > &bounds)
 Constructor from a IMultiGradFunction interface that is externally managed vector specifying the variable types (free, bounded or fixed, defined in enum EMinimVariableTypes ) variable values (used for the fixed ones) and a map with the bounds (for the bounded variables) More...
 
 ~MinimTransformFunction () override
 Destructor (no operation) More...
 
IMultiGenFunctionClone () const override
 clone: not supported (since unique_ptr used in the fVariables) More...
 
void GradientTransformation (const double *x, const double *gExt, double *gInt) const
 transform gradient vector (external -> internal) at internal point x More...
 
void InvStepTransformation (const double *x, const double *sext, double *sint) const
 inverse transformation for steps (external -> internal) at external point x More...
 
void InvTransformation (const double *xext, double *xint) const
 inverse transformation (external -> internal) More...
 
void MatrixTransformation (const double *x, const double *covInt, double *covExt) const
 transform covariance matrix (internal -> external) at internal point x use row storages for matrices m(i,j) = rep[ i * dim + j] More...
 
unsigned int NDim () const override
 Retrieve the dimension of the function. More...
 
unsigned int NTot () const
 
const IMultiGradFunctionOriginalFunction () const
 
const doubleTransformation (const double *x) const
 transform from internal to external result is cached also inside the class More...
 
void Transformation (const double *xint, double *xext) const
 transform from internal to external More...
 
- Public Member Functions inherited from ROOT::Math::IGradientFunctionMultiDimTempl< T >
virtual ~IGradientFunctionMultiDimTempl ()
 Virtual Destructor (no operations) More...
 
virtual void FdF (const T *x, T &f, T *df) const
 Optimized method to evaluate at the same time the function value and derivative at a point x. More...
 
virtual void Gradient (const T *x, T *grad) const
 Evaluate all the vector of function derivatives (gradient) at a point x. More...
 
virtual void GradientWithPrevResult (const T *x, T *grad, T *previous_grad, T *previous_g2, T *previous_gstep) const
 In some cases, the gradient algorithm will use information from the previous step, these can be passed in with this overload. More...
 
virtual unsigned int NDim () const=0
 Retrieve the dimension of the function. More...
 
virtual bool returnsInMinuit2ParameterSpace () const
 
- Public Member Functions inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
 IBaseFunctionMultiDimTempl ()
 
virtual ~IBaseFunctionMultiDimTempl ()
 virtual destructor More...
 
virtual IBaseFunctionMultiDimTempl< T > * Clone () const =0
 Clone a function. More...
 
virtual unsigned int NDim () const =0
 Retrieve the dimension of the function. More...
 
operator() (const T *x) const
 Evaluate the function at a point x[]. More...
 
- Public Member Functions inherited from ROOT::Math::IGradientMultiDimTempl< T >
virtual ~IGradientMultiDimTempl ()
 virtual destructor More...
 
Derivative (const T *x, unsigned int icoord, T *previous_grad, T *previous_g2, T *previous_gstep) const
 In some cases, the derivative algorithm will use information from the previous step, these can be passed in with this overload. More...
 
Derivative (const T *x, unsigned int icoord=0) const
 Return the partial derivative with respect to the passed coordinate. More...
 
virtual void FdF (const T *x, T &f, T *df) const =0
 Optimized method to evaluate at the same time the function value and derivative at a point x. More...
 
virtual void Gradient (const T *x, T *grad) const =0
 Evaluate all the vector of function derivatives (gradient) at a point x. More...
 

Private Member Functions

 MinimTransformFunction (const MinimTransformFunction &)
 
double DoDerivative (const double *x, unsigned int icoord) const override
 calculate derivatives More...
 
double DoEval (const double *x) const override
 function evaluation More...
 
MinimTransformFunctionoperator= (const MinimTransformFunction &)
 

Private Attributes

const IMultiGradFunctionfFunc
 user function More...
 
std::vector< unsigned intfIndex
 vector with external indices for internal variables More...
 
std::vector< MinimTransformVariablefVariables
 vector of variable settings and tranformation function More...
 
std::vector< doublefX
 internal cached of external values More...
 

#include <Math/MinimTransformFunction.h>

Inheritance diagram for ROOT::Math::MinimTransformFunction:
[legend]

Member Typedef Documentation

◆ BaseFunc

◆ BaseGradFunc

Constructor & Destructor Documentation

◆ MinimTransformFunction() [1/2]

ROOT::Math::MinimTransformFunction::MinimTransformFunction ( const IMultiGradFunction f,
const std::vector< ROOT::Math::EMinimVariableType > &  types,
const std::vector< double > &  values,
const std::map< unsigned int, std::pair< double, double > > &  bounds 
)

Constructor from a IMultiGradFunction interface that is externally managed vector specifying the variable types (free, bounded or fixed, defined in enum EMinimVariableTypes ) variable values (used for the fixed ones) and a map with the bounds (for the bounded variables)

Definition at line 24 of file MinimTransformFunction.cxx.

◆ ~MinimTransformFunction()

ROOT::Math::MinimTransformFunction::~MinimTransformFunction ( )
inlineoverride

Destructor (no operation)

Definition at line 62 of file MinimTransformFunction.h.

◆ MinimTransformFunction() [2/2]

ROOT::Math::MinimTransformFunction::MinimTransformFunction ( const MinimTransformFunction )
inlineprivate

Definition at line 127 of file MinimTransformFunction.h.

Member Function Documentation

◆ Clone()

IMultiGenFunction * ROOT::Math::MinimTransformFunction::Clone ( ) const
inlineoverridevirtual

clone: not supported (since unique_ptr used in the fVariables)

Implements ROOT::Math::IBaseFunctionMultiDimTempl< T >.

Definition at line 71 of file MinimTransformFunction.h.

◆ DoDerivative()

double ROOT::Math::MinimTransformFunction::DoDerivative ( const double x,
unsigned int  icoord 
) const
inlineoverrideprivate

calculate derivatives

Definition at line 118 of file MinimTransformFunction.h.

◆ DoEval()

double ROOT::Math::MinimTransformFunction::DoEval ( const double x) const
inlineoverrideprivate

function evaluation

Definition at line 107 of file MinimTransformFunction.h.

◆ GradientTransformation()

void ROOT::Math::MinimTransformFunction::GradientTransformation ( const double x,
const double gExt,
double gInt 
) const

transform gradient vector (external -> internal) at internal point x

Definition at line 121 of file MinimTransformFunction.cxx.

◆ InvStepTransformation()

void ROOT::Math::MinimTransformFunction::InvStepTransformation ( const double x,
const double sext,
double sint 
) const

inverse transformation for steps (external -> internal) at external point x

Definition at line 100 of file MinimTransformFunction.cxx.

◆ InvTransformation()

void ROOT::Math::MinimTransformFunction::InvTransformation ( const double xext,
double xint 
) const

inverse transformation (external -> internal)

Definition at line 87 of file MinimTransformFunction.cxx.

◆ MatrixTransformation()

void ROOT::Math::MinimTransformFunction::MatrixTransformation ( const double x,
const double covInt,
double covExt 
) const

transform covariance matrix (internal -> external) at internal point x use row storages for matrices m(i,j) = rep[ i * dim + j]

Definition at line 136 of file MinimTransformFunction.cxx.

◆ NDim()

unsigned int ROOT::Math::MinimTransformFunction::NDim ( ) const
inlineoverridevirtual

Retrieve the dimension of the function.

Implements ROOT::Math::IBaseFunctionMultiDimTempl< T >.

Definition at line 66 of file MinimTransformFunction.h.

◆ NTot()

unsigned int ROOT::Math::MinimTransformFunction::NTot ( ) const
inline

Definition at line 68 of file MinimTransformFunction.h.

◆ operator=()

MinimTransformFunction & ROOT::Math::MinimTransformFunction::operator= ( const MinimTransformFunction )
inlineprivate

Definition at line 132 of file MinimTransformFunction.h.

◆ OriginalFunction()

const IMultiGradFunction * ROOT::Math::MinimTransformFunction::OriginalFunction ( ) const
inline

Definition at line 101 of file MinimTransformFunction.h.

◆ Transformation() [1/2]

const double * ROOT::Math::MinimTransformFunction::Transformation ( const double x) const
inline

transform from internal to external result is cached also inside the class

Definition at line 78 of file MinimTransformFunction.h.

◆ Transformation() [2/2]

void ROOT::Math::MinimTransformFunction::Transformation ( const double xint,
double xext 
) const

transform from internal to external

Definition at line 63 of file MinimTransformFunction.cxx.

Member Data Documentation

◆ fFunc

const IMultiGradFunction* ROOT::Math::MinimTransformFunction::fFunc
private

user function

Definition at line 143 of file MinimTransformFunction.h.

◆ fIndex

std::vector<unsigned int> ROOT::Math::MinimTransformFunction::fIndex
private

vector with external indices for internal variables

Definition at line 142 of file MinimTransformFunction.h.

◆ fVariables

std::vector<MinimTransformVariable> ROOT::Math::MinimTransformFunction::fVariables
private

vector of variable settings and tranformation function

Definition at line 141 of file MinimTransformFunction.h.

◆ fX

std::vector<double> ROOT::Math::MinimTransformFunction::fX
mutableprivate

internal cached of external values

Definition at line 140 of file MinimTransformFunction.h.

Libraries for ROOT::Math::MinimTransformFunction:
[legend]

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