ROOT::Math::GradFunctor Class Reference

Description

GradFunctor class for Multidimensional gradient functions. It is used to wrap in a very C++ callable object to make gradient functions. It can be constructed in three different way:

1. from an object implementing both double operator()( const double * ) for the function evaluation and double Derivative(const double *, int icoord) for the partial derivatives
2. from an object implementing any member function like Foo::XXX(const double *) for the function evaluation and any member function like Foo::XXX(const double *, int icoord) for the partial derivatives
3. from an function object implementing double operator()( const double * ) for the function evaluation and another function object implementing double operator() (const double *, int icoord) for the partial derivatives

The function dimension is required when constructing the functor.

Definition at line 577 of file Functor.h.

Inheritance diagram for ROOT::Math::GradFunctor:

Collaboration diagram for ROOT::Math::GradFunctor:

Public Types
typedef T	BackendType
typedef IBaseFunctionMultiDimTempl< T >	BaseFunc
typedef IGradientMultiDimTempl< T >	BaseGrad
typedef FunctorImpl< IGradientFunctionMultiDim >	Impl
typedef IGradientFunctionMultiDim::BaseFunc	ImplBase

Public Member Functions
	GradFunctor ()
template<typename Func , typename GradFunc >
	GradFunctor (const Func &f, const GradFunc &g, int dim)
template<typename Func >
	GradFunctor (const Func &f, unsigned int dim)
	GradFunctor (const GradFunctor &rhs)
template<class PtrObj , typename MemFn , typename GradMemFn >
	GradFunctor (const PtrObj &p, MemFn memFn, GradMemFn gradFn, unsigned int dim)
virtual	~GradFunctor ()
ImplBase *	Clone () const
T	Derivative (const T *x, unsigned int icoord=0) const
virtual void	FdF (const T *x, T &f, T *df) const
virtual void	Gradient (const T *x, T *grad) const
unsigned int	NDim () const
virtual unsigned int	NDim () const=0
T	operator() (const T *x) const
GradFunctor &	operator= (const GradFunctor &rhs)

Private Member Functions
double	DoDerivative (const double *x, unsigned int icoord) const
double	DoEval (const double *x) const

Private Attributes
std::unique_ptr< Impl >	fImpl

Member Typedef Documentation

BackendType

template<class T >

typedef T ROOT::Math::IBaseFunctionMultiDimTempl< T >::BackendType

inherited

Definition at line 66 of file IFunction.h.

BaseFunc

template<class T >

typedef IBaseFunctionMultiDimTempl<T> ROOT::Math::IGradientFunctionMultiDimTempl< T >::BaseFunc

inherited

Definition at line 330 of file IFunction.h.

BaseGrad

template<class T >

typedef IGradientMultiDimTempl<T> ROOT::Math::IGradientFunctionMultiDimTempl< T >::BaseGrad

inherited

Definition at line 331 of file IFunction.h.

Impl

typedef FunctorImpl<IGradientFunctionMultiDim> ROOT::Math::GradFunctor::Impl

Definition at line 582 of file Functor.h.

ImplBase

typedef IGradientFunctionMultiDim::BaseFunc ROOT::Math::GradFunctor::ImplBase

Definition at line 583 of file Functor.h.

Constructor & Destructor Documentation

GradFunctor() [1/5]

ROOT::Math::GradFunctor::GradFunctor ( )

inline

Default constructor

Definition at line 589 of file Functor.h.

{}

Referenced by Clone().

GradFunctor() [2/5]

template<typename Func >

ROOT::Math::GradFunctor::GradFunctor ( const Func &  f, unsigned int  dim  )

inline

construct from a callable object of multi-dimension implementing operator()(const double *x) and Derivative(const double * x,icoord)

Definition at line 597 of file Functor.h.

                                                   :
      fImpl(new FunctorHandler<GradFunctor,Func>(dim,f) )
   {}

GradFunctor() [3/5]

template<class PtrObj , typename MemFn , typename GradMemFn >

ROOT::Math::GradFunctor::GradFunctor ( const PtrObj &  p, MemFn  memFn, GradMemFn  gradFn, unsigned int  dim  )

inline

construct from a pointer to member function and member function types for function and derivative evaluations

Definition at line 605 of file Functor.h.

      : fImpl(new MemGradFunHandler<GradFunctor, PtrObj, MemFn, GradMemFn>(dim, p, memFn, gradFn))
   {}

GradFunctor() [4/5]

template<typename Func , typename GradFunc >

ROOT::Math::GradFunctor::GradFunctor ( const Func &  f, const GradFunc &  g, int  dim  )

inline

construct for Gradient Functions of multi-dimension Func gives the function evaluatiion, GradFunc the partial derivatives The function dimension is required

Definition at line 615 of file Functor.h.

                                                              :
      fImpl(new FunctorGradHandler<GradFunctor,Func,GradFunc>(dim, f, g) )
   { }

~GradFunctor()

virtual ROOT::Math::GradFunctor::~GradFunctor ( )

inlinevirtual

Destructor (no operations)

Definition at line 623 of file Functor.h.

{}

GradFunctor() [5/5]

ROOT::Math::GradFunctor::GradFunctor ( const GradFunctor &  rhs )

inline

Copy constructor for functor based on ROOT::Math::IMultiGradFunction

Definition at line 629 of file Functor.h.

                                        :
      ImplBase()
   {
      if (rhs.fImpl)
         fImpl = std::unique_ptr<Impl>(rhs.fImpl->Copy());
   }

References fImpl.

Member Function Documentation

Clone()

ImplBase* ROOT::Math::GradFunctor::Clone ( ) const

inlinevirtual

Clone a function. Each derived class must implement their version of the Clone method

Implements ROOT::Math::IBaseFunctionMultiDimTempl< T >.

Definition at line 647 of file Functor.h.

{ return new GradFunctor(*this); }

References GradFunctor().

Here is the call graph for this function:

Derivative()

template<class T >

T ROOT::Math::IGradientMultiDimTempl< T >::Derivative ( const T *  x, unsigned int  icoord = 0  ) const

inlineinherited

Return the partial derivative with respect to the passed coordinate

Definition at line 217 of file IFunction.h.

{ return DoDerivative(x, icoord); }

References ROOT::Math::IGradientMultiDimTempl< T >::DoDerivative().

Referenced by ROOT::Math::MinimTransformFunction::DoDerivative(), and ROOT::Math::IGradientFunctionMultiDimTempl< T >::Gradient().

Here is the call graph for this function:

DoDerivative()

double ROOT::Math::GradFunctor::DoDerivative ( const double *  x, unsigned int  icoord  ) const

inlineprivate

Definition at line 660 of file Functor.h.

                                                                              {
      return fImpl->Derivative(x,icoord);
   }

References fImpl.

DoEval()

double ROOT::Math::GradFunctor::DoEval ( const double *  x ) const

inlineprivate

Definition at line 655 of file Functor.h.

                                                 {
      return (*fImpl)(x);
   }

References fImpl.

FdF()

template<class T >

virtual void ROOT::Math::IGradientFunctionMultiDimTempl< T >::FdF ( const T *  x, T &  f, T *  df  ) const

inlinevirtualinherited

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

Implements ROOT::Math::IGradientMultiDimTempl< T >.

Definition at line 357 of file IFunction.h.

         {
            f = BaseFunc::operator()(x);
            Gradient(x, df);
         }

References ROOT::Math::IGradientFunctionMultiDimTempl< T >::Gradient(), and ROOT::Math::IBaseFunctionMultiDimTempl< T >::operator()().

Here is the call graph for this function:

Gradient()

template<class T >

virtual void ROOT::Math::IGradientFunctionMultiDimTempl< T >::Gradient ( const T *  x, T *  grad  ) const

inlinevirtualinherited

Evaluate all the vector of function derivatives (gradient) at a point x. Derived classes must re-implement it if more efficient than evaluting one at a time

Implements ROOT::Math::IGradientMultiDimTempl< T >.

Definition at line 342 of file IFunction.h.

         {
            unsigned int ndim = NDim();
            for (unsigned int icoord  = 0; icoord < ndim; ++icoord)
               grad[icoord] = BaseGrad::Derivative(x, icoord);
         }

References ROOT::Math::IGradientMultiDimTempl< T >::Derivative(), and ROOT::Math::IGradientFunctionMultiDimTempl< T >::NDim().

Referenced by ROOT::Math::IGradientFunctionMultiDimTempl< T >::FdF().

Here is the call graph for this function:

NDim() [1/2]

unsigned int ROOT::Math::GradFunctor::NDim ( ) const

inlinevirtual

Retrieve the dimension of the function

Implements ROOT::Math::IBaseFunctionMultiDimTempl< T >.

Definition at line 650 of file Functor.h.

{ return fImpl->NDim(); }

References fImpl.

NDim() [2/2]

template<class T >

virtual unsigned int ROOT::Math::IBaseFunctionMultiDimTempl< T >::NDim

inherited

Retrieve the dimension of the function

Referenced by ROOT::Math::IGradientFunctionMultiDimTempl< T >::Gradient(), ROOT::Math::MinimTransformFunction::NTot(), and ROOT::Math::GSLMultiMinimizer::Set().

operator()()

template<class T >

T ROOT::Math::IBaseFunctionMultiDimTempl< T >::operator() ( const T *  x ) const

inlineinherited

Evaluate the function at a point x[]. Use the pure virtual private method DoEval which must be implemented by the sub-classes

Definition at line 92 of file IFunction.h.

         {
            return DoEval(x);
         }

References ROOT::Math::IBaseFunctionMultiDimTempl< T >::DoEval().

Referenced by ROOT::Math::IGradientFunctionMultiDimTempl< T >::FdF().

Here is the call graph for this function:

operator=()

GradFunctor& ROOT::Math::GradFunctor::operator= ( const GradFunctor &  rhs )

inline

Assignment operator

Definition at line 639 of file Functor.h.

                                                       {
      GradFunctor copy(rhs);
      fImpl.swap(copy.fImpl);
      return *this;
   }

References fImpl.

Member Data Documentation

fImpl

std::unique_ptr<Impl> ROOT::Math::GradFunctor::fImpl

private

Definition at line 664 of file Functor.h.

Referenced by GradFunctor(), DoDerivative(), DoEval(), NDim(), and operator=().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Fit/3rdparty/RootMinimizers/mathcore/Math/Functor.h