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

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 112 of file IFunction.h.

Public Types

typedef IBaseFunctionOneDim BaseFunc
 

Public Member Functions

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.
 

Private Member Functions

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:
[legend]

Member Typedef Documentation

◆ BaseFunc

Constructor & Destructor Documentation

◆ ~IBaseFunctionOneDim()

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

Member Function Documentation

◆ Clone()

◆ DoEval()

◆ HasGradient()

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

Reimplemented in ROOT::Math::IGradientFunctionOneDim.

Definition at line 134 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 130 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 126 of file IFunction.h.


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