class 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  CppFunctions

Function Members (Methods)

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

doubleDerivative(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
ROOT::Math::IGradientMultiDim&operator=(const ROOT::Math::IGradientMultiDim&)
virtual doubleDoDerivative(const double* x, unsigned int icoord) const

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

virtual ~IGradientMultiDim()
 virual destructor
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

double Derivative(const double* x, unsigned int icoord = 0) const
Return the partial derivative with respect to the passed coordinate

return DoDerivative(const double* x, unsigned int icoord) const
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
valuate value and derivative at the same tim

Last update: root/mathcore:$Id: IFunction.h 21553 2007-12-21 10:55:46Z moneta $
Copyright (c) 2006 , LCG ROOT MathLib Team *

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.