Logo ROOT   6.19/01
Reference Guide
ROOT::Math::IParametricFunctionMultiDimTempl< T > Class Template Referenceabstract

template<class T>
class ROOT::Math::IParametricFunctionMultiDimTempl< T >

IParamFunction interface (abstract class) describing multi-dimensional parameteric functions It is a derived class from ROOT::Math::IBaseFunctionMultiDim and ROOT::Math::IBaseParam.

Provides the interface for evaluating a function passing a coordinate vector and a parameter vector.

Definition at line 104 of file IParamFunction.h.

Public Types

typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 
- Public Types inherited from ROOT::Math::IBaseFunctionMultiDimTempl< T >
typedef T BackendType
 
typedef IBaseFunctionMultiDimTempl< T > BaseFunc
 

Public Member Functions

operator() (const T *x, const double *p) const
 
Evaluate function at a point x and for given parameters p. More...
 
operator() (const T *x) 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::IBaseParam
virtual ~IBaseParam ()
 Virtual Destructor (no operations) More...
 
virtual unsigned int NPar () const =0
 Return the number of Parameters. More...
 
virtual std::string ParameterName (unsigned int i) const
 Return the name of the i-th parameter (starting from zero) Overwrite if want to avoid the default name ("Par_0, Par_1, ...") More...
 
virtual const double * Parameters () const =0
 Access the parameter values. More...
 
virtual void SetParameters (const double *p)=0
 Set the parameter values. More...
 

Private Member Functions

virtual T DoEval (const T *x) const
 Implement the ROOT::Math::IBaseFunctionMultiDim interface DoEval(x) using the cached parameter values. More...
 
virtual T DoEvalPar (const T *x, const double *p) const =0
 Implementation of the evaluation function using the x values and the parameters. More...
 

#include <Math/IParamFunction.h>

Inheritance diagram for ROOT::Math::IParametricFunctionMultiDimTempl< T >:
[legend]

Member Typedef Documentation

◆ BaseFunc

Definition at line 108 of file IParamFunction.h.

Member Function Documentation

◆ DoEval()

template<class T>
virtual T ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEval ( const T *  x) const
inlineprivatevirtual

◆ DoEvalPar()

template<class T>
virtual T ROOT::Math::IParametricFunctionMultiDimTempl< T >::DoEvalPar ( const T *  x,
const double *  p 
) const
privatepure virtual

Implementation of the evaluation function using the x values and the parameters.

Must be implemented by derived classes

Implemented in ROOT::Math::IParametricGradFunctionMultiDimTempl< T >, ROOT::Math::WrappedParamFunctionGen< FuncPtr >, ROOT::Math::WrappedMultiTF1Templ< T >, and ROOT::Math::MultiDimParamFunctionAdapter.

◆ operator()() [1/2]

template<class T>
T ROOT::Math::IParametricFunctionMultiDimTempl< T >::operator() ( const T *  x,
const double *  p 
) const
inline


Evaluate function at a point x and for given parameters p.

This method does not change the internal status of the function (internal parameter values). If for some reason one prefers caching the parameter values, SetParameters(p) and then operator()(x) should be called. Use the pure virtual function DoEvalPar to implement it

Definition at line 120 of file IParamFunction.h.

◆ operator()() [2/2]

template<class T>
T ROOT::Math::IParametricFunctionMultiDimTempl< T >::operator() ( const T *  x) const
inline

Definition at line 125 of file IParamFunction.h.


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