Loading [MathJax]/extensions/tex2jax.js
Logo ROOT  

Reference Guide
 
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Loading...
Searching...
No Matches
List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROOT::Math::GradFunctor1D Class Reference
Math » MathCore » Function Classes and Interfaces » Generic Function Evaluation Interfaces

GradFunctor1D class for one-dimensional gradient functions.

It is used to wrap in a very C++ callable object to make a 1D gradient functions. It can be constructed in three different way:

  1. from an object implementing both double operator()( double ) for the function evaluation and double Derivative(double ) for the partial derivatives
  2. from an object implementing any member function like Foo::XXX(double ) for the function evaluation and any other member function like Foo::YYY(double ) for the derivative.
  3. from an 2 function objects implementing double operator()( double ) . One object provides the function evaluation, the other the derivative.

Definition at line 730 of file Functor.h.

Public Types

typedef FunctorImpl< IGradientFunctionOneDim > Impl
 
typedef IGradientFunctionOneDim::BaseFunc ImplBase
 
- Public Types inherited from ROOT::Math::IGradientFunctionOneDim
typedef IBaseFunctionOneDim BaseFunc
 
typedef IGradientOneDim BaseGrad
 
- Public Types inherited from ROOT::Math::IBaseFunctionOneDim
typedef IBaseFunctionOneDim BaseFunc
 

Public Member Functions

 GradFunctor1D ()
 Default constructor.
 
template<typename Func >
 GradFunctor1D (const Func &f)
 construct from an object with the right signature implementing both operator() (double x) and Derivative(double x)
 
template<typename Func , typename GradFunc >
 GradFunctor1D (const Func &f, const GradFunc &g)
 construct from two 1D function objects
 
 GradFunctor1D (const GradFunctor1D &rhs)
 Copy constructor for Functor based on ROOT::Math::IGradFunction.
 
template<class PtrObj , typename MemFn , typename GradMemFn >
 GradFunctor1D (const PtrObj &p, MemFn memFn, GradMemFn gradFn)
 construct from a pointer to class and two pointers to member functions, one for the function evaluation and the other for the derivative.
 
 GradFunctor1D (const std::function< double(double)> &f, const std::function< double(double)> &g)
 specialized constructor from 2 std::function objects implementing double operator()(double x).
 
virtual ~GradFunctor1D ()
 Destructor (no operations)
 
ImplBase * Clone () const
 Clone a function.
 
GradFunctor1D & operator= (const GradFunctor1D &rhs)
 Assignment operator.
 
- Public Member Functions inherited from ROOT::Math::IGradientFunctionOneDim
virtual ~IGradientFunctionOneDim ()
 Virtual Destructor (no operations)
 
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.
 
- Public Member Functions inherited from ROOT::Math::IBaseFunctionOneDim
 IBaseFunctionOneDim ()
 
virtual ~IBaseFunctionOneDim ()
 virtual destructor
 
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 Use the a pure virtual private method DoEval which must be implemented by sub-classes.
 
- Public Member Functions inherited from ROOT::Math::IGradientOneDim
virtual ~IGradientOneDim ()
 virtual destructor
 
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.
 
void Gradient (const double *x, double *g) const
 Compatibility method with multi-dimensional interface for Gradient.
 

Private Member Functions

double DoDerivative (double x) const
 function to evaluate the derivative with respect each coordinate.
 
double DoEval (double x) const
 implementation of the evaluation function. Must be implemented by derived classes
 

Private Attributes

std::unique_ptr< Impl > fImpl
 

#include <Math/Functor.h>

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

Member Typedef Documentation

◆ Impl

typedef FunctorImpl<IGradientFunctionOneDim> ROOT::Math::GradFunctor1D::Impl

Definition at line 735 of file Functor.h.

◆ ImplBase

typedef IGradientFunctionOneDim::BaseFunc ROOT::Math::GradFunctor1D::ImplBase

Definition at line 736 of file Functor.h.

Constructor & Destructor Documentation

◆ GradFunctor1D() [1/6]

ROOT::Math::GradFunctor1D::GradFunctor1D ( )
inline

Default constructor.

Definition at line 742 of file Functor.h.

◆ GradFunctor1D() [2/6]

template<typename Func >
ROOT::Math::GradFunctor1D::GradFunctor1D ( const Func &  f)
inline

construct from an object with the right signature implementing both operator() (double x) and Derivative(double x)

Definition at line 750 of file Functor.h.

◆ GradFunctor1D() [3/6]

template<class PtrObj , typename MemFn , typename GradMemFn >
ROOT::Math::GradFunctor1D::GradFunctor1D ( const PtrObj &  p,
MemFn  memFn,
GradMemFn  gradFn 
)
inline

construct from a pointer to class and two pointers to member functions, one for the function evaluation and the other for the derivative.

The member functions must take a double as argument and return a double

Definition at line 761 of file Functor.h.

◆ GradFunctor1D() [4/6]

template<typename Func , typename GradFunc >
ROOT::Math::GradFunctor1D::GradFunctor1D ( const Func &  f,
const GradFunc &  g 
)
inline

construct from two 1D function objects

Definition at line 771 of file Functor.h.

◆ GradFunctor1D() [5/6]

ROOT::Math::GradFunctor1D::GradFunctor1D ( const std::function< double(double)> &  f,
const std::function< double(double)> &  g 
)
inline

specialized constructor from 2 std::function objects implementing double operator()(double x).

The first one for the function evaluation and the second one implementing the function derivative. This specialized constructor is introduced in order to use the class in Python passing Python user defined functions

Definition at line 782 of file Functor.h.

◆ ~GradFunctor1D()

virtual ROOT::Math::GradFunctor1D::~GradFunctor1D ( )
inlinevirtual

Destructor (no operations)

Definition at line 789 of file Functor.h.

◆ GradFunctor1D() [6/6]

ROOT::Math::GradFunctor1D::GradFunctor1D ( const GradFunctor1D &  rhs)
inline

Copy constructor for Functor based on ROOT::Math::IGradFunction.

Definition at line 795 of file Functor.h.

Member Function Documentation

◆ Clone()

ImplBase * ROOT::Math::GradFunctor1D::Clone ( ) const
inlinevirtual

Clone a function.

Each derived class will implement their version of the provate DoClone method

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 815 of file Functor.h.

◆ DoDerivative()

double ROOT::Math::GradFunctor1D::DoDerivative ( double  x) const
inlineprivatevirtual

function to evaluate the derivative with respect each coordinate.

To be implemented by the derived class

Implements ROOT::Math::IGradientOneDim.

Definition at line 826 of file Functor.h.

◆ DoEval()

double ROOT::Math::GradFunctor1D::DoEval ( double  x) const
inlineprivatevirtual

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

Implements ROOT::Math::IBaseFunctionOneDim.

Definition at line 821 of file Functor.h.

◆ operator=()

GradFunctor1D & ROOT::Math::GradFunctor1D::operator= ( const GradFunctor1D &  rhs)
inline

Assignment operator.

Definition at line 807 of file Functor.h.

Member Data Documentation

◆ fImpl

std::unique_ptr<Impl> ROOT::Math::GradFunctor1D::fImpl
private

Definition at line 830 of file Functor.h.

Libraries for ROOT::Math::GradFunctor1D:
[legend]
The documentation for this class was generated from the following file: