class ROOT::Math::IParametricGradFunctionOneDim: public ROOT::Math::IParametricFunctionOneDim


    Documentation for the abstract class IBaseParam.
    It defines the interface for dealing with the function parameters
    This is used only for internal convinience, to avoid redefining the Parameter API
    for the one and the multi-dim functions.
    Concrete class should derive from ROOT::Math::IParamFunction and not from this class.

    @ingroup  ParamFunc

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

ROOT::Fit::Fitter::IGradModel1DFunction, ROOT::Math::WrappedTF1::BaseGradFunc, ROOT::Math::ParamFunction<ROOT::Math::IParametricGradFunctionOneDim>::BaseParFunc, ROOT::Math::IParamGradFunction

Function Members (Methods)

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

public:
virtual~IParametricGradFunctionOneDim()
virtual ROOT::Math::IBaseFunctionOneDim*ROOT::Math::IBaseFunctionOneDim::Clone() const
virtual unsigned intROOT::Math::IBaseParam::NPar() const
doubleROOT::Math::IParametricFunctionOneDim::operator()(double x, const double* p) const
doubleROOT::Math::IParametricFunctionOneDim::operator()(const double* x, const double* p)
ROOT::Math::IParametricGradFunctionOneDim&operator=(const ROOT::Math::IParametricGradFunctionOneDim&)
doubleParameterDerivative(double x, unsigned int ipar = 0) const
doubleParameterDerivative(const double* x, unsigned int ipar = 0) const
doubleParameterDerivative(double x, const double* p, unsigned int ipar = 0) const
doubleParameterDerivative(const double* x, const double* p, unsigned int ipar = 0) const
voidParameterGradient(double x, double* grad) const
voidParameterGradient(const double* x, double* grad) const
virtual voidParameterGradient(double x, const double* p, double* grad) const
voidParameterGradient(const double* x, const double* p, double* grad) const
virtual stringROOT::Math::IBaseParam::ParameterName(unsigned int i) const
virtual const double*ROOT::Math::IBaseParam::Parameters() const
virtual voidROOT::Math::IBaseParam::SetParameters(const double* p)
private:
virtual doubleDoParameterDerivative(double x, const double* p, unsigned int ipar) const

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

void ParameterGradient(const double * x , const double * p, double * grad )
      Evaluate the all the derivatives (gradient vector) of the function with respect to the parameters at a point x.
      It is optional to be implemented by the derived classes for better efficiency

double ParameterDerivative(const double * x, const double * p, unsigned int ipar = 0)
      Evaluate the partial derivative w.r.t a parameter ipar from values and parameters

return DoParameterDerivative(double x, const double* p, unsigned int ipar) const
void ParameterGradient(const double * x , double * grad )
      Evaluate all derivatives using cached parameter values

return ParameterGradient(x, Parameters(), grad)
double ParameterDerivative(const double * x, unsigned int ipar = 0)
      Evaluate partial derivative using cached parameter values

virtual ~IParametricGradFunctionOneDim()
      Virtual Destructor (no operations)

{}
void ParameterGradient(double x , const double * p, double * grad )
      Evaluate the derivatives of the function with respect to the parameters at a point x.
      It is optional to be implemented by the derived classes for better efficiency if needed

double ParameterDerivative(double x, const double * p, unsigned int ipar = 0)
      Partial derivative with respect a parameter

double ParameterDerivative(double x, unsigned int ipar = 0)
      Evaluate partial derivative using cached parameter values


Author: L. Moneta Tue Nov 14 14:20:07 2006
Last change: root/mathcore:$Id: IParamFunction.h 24482 2008-06-23 15:33:08Z moneta $
Last generated: 2008-06-25 08:29
Copyright (c) 2006 LCG ROOT Math Team, CERN/PH-SFT *

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.