Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Math::IParametricFunctionOneDim Class Referenceabstract

Specialized IParamFunction interface (abstract class) for one-dimensional parametric functions It is a derived class from ROOT::Math::IBaseFunctionOneDim and ROOT::Math::IBaseParam.

Definition at line 159 of file IParamFunction.h.

Public Types

typedef IBaseFunctionOneDim BaseFunc
 
- Public Types inherited from ROOT::Math::IBaseFunctionOneDim
typedef IBaseFunctionOneDim BaseFunc
 

Public Member Functions

double operator() (const double *x, const double *p) const
 multidim-like interface
 
double operator() (double x, const double *p) const
 Evaluate function at a point x and for given parameters p.
 
- Public Member Functions inherited from ROOT::Math::IBaseFunctionOneDim
virtual ~IBaseFunctionOneDim ()=default
 
virtual IBaseFunctionOneDimClone () const =0
 Clone a function.
 
virtual bool HasGradient () const
 
double operator() (const double *x) const
 Evaluate the function at a point x[].
 
double operator() (double x) const
 Evaluate the function at a point x.
 
- Public Member Functions inherited from ROOT::Math::IBaseParam
virtual ~IBaseParam ()
 Virtual Destructor (no operations)
 
virtual unsigned int NPar () const =0
 Return the number of Parameters.
 
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, ...")
 
virtual const doubleParameters () const =0
 Access the parameter values.
 
virtual void SetParameters (const double *p)=0
 Set the parameter values.
 

Private Member Functions

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

#include <Math/IParamFunction.h>

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

Member Typedef Documentation

◆ BaseFunc

Member Function Documentation

◆ DoEval()

double ROOT::Math::IParametricFunctionOneDim::DoEval ( double  x) const
inlineoverrideprivatevirtual

Implement the ROOT::Math::IBaseFunctionOneDim interface DoEval(x) using the cached parameter values.

Implements ROOT::Math::IBaseFunctionOneDim.

Reimplemented in ROOT::Math::WrappedTF1, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, and ROOT::Math::VavilovAccurateQuantile.

Definition at line 203 of file IParamFunction.h.

◆ DoEvalPar()

virtual double ROOT::Math::IParametricFunctionOneDim::DoEvalPar ( double  x,
const double p 
) const
privatepure virtual

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

Must be implemented by derived classes

Implemented in ROOT::Math::WrappedTF1, ROOT::Math::Polynomial, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, and ROOT::Math::VavilovAccurateQuantile.

◆ operator()() [1/2]

double ROOT::Math::IParametricFunctionOneDim::operator() ( const double x,
const double p 
) const
inline

multidim-like interface

Definition at line 187 of file IParamFunction.h.

◆ operator()() [2/2]

double ROOT::Math::IParametricFunctionOneDim::operator() ( double  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 178 of file IParamFunction.h.

Libraries for ROOT::Math::IParametricFunctionOneDim:

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