ROOT logo
ROOT » MATH » MATHCORE » ROOT::Math::IGradientFunctionMultiDim

class ROOT::Math::IGradientFunctionMultiDim: public ROOT::Math::IBaseFunctionMultiDim, public ROOT::Math::IGradientMultiDim

       Documentation for the abstract class IBaseFunctionMultiDim.
       Interface (abstract class) for generic functions objects of multi-dimension
       Provides a method to evaluate the function given a vector of coordinate values,
       by implementing operator() (const double *).
       In addition it defines the interface for copying functions via the pure virtual method Clone()
       and the interface for getting the function dimension via the NDim() method.
       Derived classes must implement the pure private virtual method DoEval(const double *) for the
       function evaluation in addition to NDim() and Clone().

       @ingroup  GenFunc

This class is also known as (typedefs to this class)

ROOT::Math::IMultiGradFunction, ROOT::Fit::Fitter::BaseGradFunc, ROOT::Math::IParametricGradFunctionMultiDim::BaseGradFunc, ROOT::Math::GradFunctor::Impl

Function Members (Methods)

    This is an abstract class, constructors will not be documented.
    Look at the header to check for available constructors.

virtual ROOT::Math::IBaseFunctionMultiDim*ROOT::Math::IBaseFunctionMultiDim::Clone() const
doubleROOT::Math::IGradientMultiDim::Derivative(const double* x, unsigned int icoord = 0) const
virtual voidFdF(const double* x, double& f, double* df) const
virtual voidGradient(const double* x, double* grad) const
virtual unsigned intROOT::Math::IBaseFunctionMultiDim::NDim() const
doubleROOT::Math::IBaseFunctionMultiDim::operator()(const double* x) const
ROOT::Math::IGradientFunctionMultiDim&operator=(const ROOT::Math::IGradientFunctionMultiDim&)

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

void Gradient(const double* x, double* grad) const
          Evaluate all the vector of function derivatives (gradient)  at a point x.
          Derived classes must re-implement if it is more efficient than evaluting one at a time

void FdF(const double* x, double& f, double* df) const
          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

virtual ~IGradientFunctionMultiDim()
          Virtual Destructor (no operations)