ROOT::Math::IBaseFunctionOneDim Class Reference

Interface (abstract class) for generic functions objects of one-dimension Provides a method to evaluate the function given a value (simple double) by implementing operator() (const double ).

In addition it defines the interface for copying functions via the pure virtual method Clone(). Derived classes must implement the pure virtual private method DoEval(double ) for the function evaluation in addition to Clone(). An interface for evaluating the function passing a vector (like for multidim functions) is also provided

Definition at line 170 of file IFunction.h.

Public Types
typedef IBaseFunctionOneDim	BaseFunc

Public Member Functions
virtual	~IBaseFunctionOneDim ()=default
virtual IBaseFunctionOneDim *	Clone () const =0
	Clone a function.
double	Derivative (const double *x) const
	Compatibility method with multi-dimensional interface for partial derivative.
double	Derivative (double x) const
	Return the derivative of the function at a point x Use the private method DoDerivative.
void	FdF (const double *x, double &f, double *df) const
	Compatibility method with multi-dimensional interface for Gradient and function evaluation.
virtual void	FdF (double x, double &f, double &df) const
	Optimized method to evaluate at the same time the function value and derivative at a point x.
void	Gradient (const double *x, double *g) const
	Compatibility method with multi-dimensional interface for Gradient.
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.

Private Member Functions
virtual double	DoDerivative (double) const
	Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.
virtual double	DoEval (double x) const =0
	implementation of the evaluation function. Must be implemented by derived classes

#include <Math/IFunction.h>

Inheritance diagram for ROOT::Math::IBaseFunctionOneDim:

Member Typedef Documentation

BaseFunc

typedef IBaseFunctionOneDim ROOT::Math::IBaseFunctionOneDim::BaseFunc

Definition at line 174 of file IFunction.h.

Constructor & Destructor Documentation

~IBaseFunctionOneDim()

virtual ROOT::Math::IBaseFunctionOneDim::~IBaseFunctionOneDim ( )

virtualdefault

Member Function Documentation

Clone()

virtual IBaseFunctionOneDim * ROOT::Math::IBaseFunctionOneDim::Clone ( ) const

pure virtual

Clone a function.

Each derived class will implement their version of the private DoClone method.

Implemented in ROOT::Math::WrappedTF1, TF1_EvalWrapper, ROOT::Math::Functor1D, ROOT::Math::GradFunctor1D, ROOT::Math::IntegrandTransform, ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >, ROOT::Math::WrappedFunction< Func >, ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >, ROOT::Math::CDFWrapper, ROOT::Math::PDFIntegral, ROOT::Math::Polynomial, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, RooStats::PosteriorCdfFunction, RooStats::PosteriorFunction, and RooStats::PosteriorFunctionFromToyMC.

Derivative() [1/2]

double ROOT::Math::IBaseFunctionOneDim::Derivative ( const double * x ) const

inline

Compatibility method with multi-dimensional interface for partial derivative.

Definition at line 199 of file IFunction.h.

Derivative() [2/2]

double ROOT::Math::IBaseFunctionOneDim::Derivative ( double x ) const

inline

Return the derivative of the function at a point x Use the private method DoDerivative.

Definition at line 196 of file IFunction.h.

DoDerivative()

virtual double ROOT::Math::IBaseFunctionOneDim::DoDerivative ( double ) const

inlineprivatevirtual

Function to evaluate the derivative with respect each coordinate. To be implemented by the derived class.

Reimplemented in ROOT::Math::WrappedTF1, ROOT::Math::GradFunctor1D, and ROOT::Math::Polynomial.

Definition at line 223 of file IFunction.h.

DoEval()

virtual double ROOT::Math::IBaseFunctionOneDim::DoEval ( double x ) const

privatepure virtual

implementation of the evaluation function. Must be implemented by derived classes

Implemented in ROOT::Math::WrappedTF1, ROOT::Math::Functor1D, ROOT::Math::GradFunctor1D, ROOT::Math::IntegrandTransform, ROOT::Math::IParametricFunctionOneDim, ROOT::Math::OneDimMultiFunctionAdapter< MultiFuncType >, ROOT::Math::OneDimParamFunctionAdapter< ParamFuncType >, ROOT::Math::WrappedFunction< Func >, ROOT::Math::WrappedMemFunction< FuncObj, MemFuncPtr >, ROOT::Math::VavilovAccurateCdf, ROOT::Math::VavilovAccuratePdf, ROOT::Math::VavilovAccurateQuantile, RooStats::PosteriorCdfFunction, RooStats::PosteriorFunction, RooStats::PosteriorFunctionFromToyMC, TF1_EvalWrapper, ROOT::Math::CDFWrapper, and ROOT::Math::PDFIntegral.

FdF() [1/2]

void ROOT::Math::IBaseFunctionOneDim::FdF ( const double * x, double & f, double * df ) const

inline

Compatibility method with multi-dimensional interface for Gradient and function evaluation.

Definition at line 215 of file IFunction.h.

FdF() [2/2]

virtual void ROOT::Math::IBaseFunctionOneDim::FdF ( double x, double & f, double & df ) const

inlinevirtual

Optimized method to evaluate at the same time the function value and derivative at a point x.

Often both value and derivatives are needed and it is often more efficient to compute them at the same time. Derived class should implement this method if performances play an important role and if it is faster to evaluate value and derivative at the same time.

Reimplemented in ROOT::Math::WrappedTF1, and ROOT::Math::Polynomial.

Definition at line 208 of file IFunction.h.

Gradient()

void ROOT::Math::IBaseFunctionOneDim::Gradient ( const double * x, double * g ) const

inline

Compatibility method with multi-dimensional interface for Gradient.

Definition at line 202 of file IFunction.h.

HasGradient()

virtual bool ROOT::Math::IBaseFunctionOneDim::HasGradient ( ) const

inlinevirtual

Reimplemented in ROOT::Math::IGradientFunctionOneDim.

Definition at line 192 of file IFunction.h.

operator()() [1/2]

double ROOT::Math::IBaseFunctionOneDim::operator() ( const double * x ) const

inline

Evaluate the function at a point x[].

Compatible method with multi-dimensional functions.

Definition at line 188 of file IFunction.h.

operator()() [2/2]

double ROOT::Math::IBaseFunctionOneDim::operator() ( double x ) const

inline

Evaluate the function at a point x.

Use the a pure virtual private method DoEval which must be implemented by sub-classes.

Definition at line 184 of file IFunction.h.

---

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

• math/mathcore/inc/Math/IFunction.h