/usr/include/root/Math/IParamFunction.h is in libroot-math-mathcore-dev 5.34.19+dfsg-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 | // @(#)root/mathcore:$Id$
// Author: L. Moneta Tue Nov 14 14:20:07 2006
/**********************************************************************
* *
* Copyright (c) 2006 LCG ROOT Math Team, CERN/PH-SFT *
* *
* *
**********************************************************************/
// Header file for class IParamFunction
#ifndef ROOT_Math_IParamFunction
#define ROOT_Math_IParamFunction
#ifndef ROOT_Math_IFunction
#include "Math/IFunction.h"
#endif
#ifndef ROOT_Math_IParamFunctionfwd
#include "Math/IParamFunctionfwd.h"
#endif
#ifndef ROOT_Math_Util
#include "Math/Util.h"
#endif
#include <cassert>
/**
@defgroup ParamFunc Interfaces for parametric functions
@ingroup CppFunctions
*/
namespace ROOT {
namespace Math {
//___________________________________________________________________
/**
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
*/
class IBaseParam {
public:
/**
Virtual Destructor (no operations)
*/
virtual ~IBaseParam () {}
/**
Access the parameter values
*/
virtual const double * Parameters() const = 0;
/**
Set the parameter values
@param p vector of doubles containing the parameter values.
to be defined: can user change number of params ? At the moment no.
*/
virtual void SetParameters(const double * p ) = 0;
/**
Return the number of Parameters
*/
virtual unsigned int NPar() const = 0;
/**
Return the name of the i-th parameter (starting from zero)
Overwrite if want to avoid the default name ("Par_0, Par_1, ...")
*/
virtual std::string ParameterName(unsigned int i) const {
assert(i < NPar() );
return "Par_" + Util::ToString(i);
}
};
//___________________________________________________________________
/**
IParamFunction interface (abstract class) describing multi-dimensional parameteric functions
It is a derived class from ROOT::Math::IBaseFunctionMultiDim and
ROOT::Math::IBaseParam
Provides the interface for evaluating a function passing a coordinate vector and a parameter vector.
@ingroup ParamFunc
*/
class IParametricFunctionMultiDim :
virtual public IBaseFunctionMultiDim ,
public IBaseParam {
public:
typedef IBaseFunctionMultiDim BaseFunc;
/**
Evaluate function at a point x and for given parameters p.
This method does not change the internal status of the function (internal parameter values).
If for some reason one prefers caching the parameter values, SetParameters(p) and then operator()(x) should be
called.
Use the pure virtual function DoEvalPar to implement it
*/
double operator() (const double * x, const double * p ) const {
return DoEvalPar(x, p);
}
using BaseFunc::operator();
private:
/**
Implementation of the evaluation function using the x values and the parameters.
Must be implemented by derived classes
*/
virtual double DoEvalPar(const double * x, const double * p) const = 0;
/**
Implement the ROOT::Math::IBaseFunctionMultiDim interface DoEval(x) using the cached parameter values
*/
virtual double DoEval(const double *x) const {
return DoEvalPar( x, Parameters() );
}
};
//___________________________________________________________________
/**
Specialized IParamFunction interface (abstract class) for one-dimensional parametric functions
It is a derived class from ROOT::Math::IBaseFunctionOneDim and
ROOT::Math::IBaseParam
@ingroup ParamFunc
*/
class IParametricFunctionOneDim :
virtual public IBaseFunctionOneDim,
public IBaseParam {
public:
typedef IBaseFunctionOneDim BaseFunc;
using BaseFunc::operator();
/**
Evaluate function at a point x and for given parameters p.
This method does not change the internal status of the function (internal parameter values).
If for some reason one prefers caching the parameter values, SetParameters(p) and then operator()(x) should be
called.
Use the pure virtual function DoEvalPar to implement it
*/
double operator() ( double x, const double * p ) const {
return DoEvalPar(x, p);
}
/**
multidim-like interface
*/
double operator() (const double * x, const double * p ) const
{
return DoEvalPar(*x, p);
}
private:
/**
Implementation of the evaluation function using the x value and the parameters.
Must be implemented by derived classes
*/
virtual double DoEvalPar(double x, const double * p) const = 0;
/**
Implement the ROOT::Math::IBaseFunctionOneDim interface DoEval(x) using the cached parameter values
*/
virtual double DoEval(double x) const {
return DoEvalPar( x, Parameters() );
}
};
//_______________________________________________________________________________
/**
Interface (abstract class) for parametric gradient multi-dimensional functions providing
in addition to function evaluation with respect to the coordinates
also the gradient with respect to the parameters, via the method ParameterGradient.
It is a derived class from ROOT::Math::IParametricFunctionMultiDim.
The pure private virtual method DoParameterGradient must be implemented by the derived classes
in addition to those inherited by the base abstract classes.
@ingroup ParamFunc
*/
class IParametricGradFunctionMultiDim :
public IParametricFunctionMultiDim
// ,public IGradientFunctionMultiDim
{
public:
typedef IParametricFunctionMultiDim BaseParamFunc;
typedef IGradientFunctionMultiDim BaseGradFunc;
typedef IParametricFunctionMultiDim::BaseFunc BaseFunc;
/**
Virtual Destructor (no operations)
*/
virtual ~IParametricGradFunctionMultiDim () {}
using BaseParamFunc::operator();
/**
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
*/
virtual void ParameterGradient(const double * x , const double * p, double * grad ) const {
unsigned int npar = NPar();
for (unsigned int ipar = 0; ipar < npar; ++ipar)
grad[ipar] = DoParameterDerivative(x,p,ipar);
}
/**
Evaluate the partial derivative w.r.t a parameter ipar from values and parameters
*/
double ParameterDerivative(const double * x, const double * p, unsigned int ipar = 0) const {
return DoParameterDerivative(x, p, ipar);
}
/**
Evaluate all derivatives using cached parameter values
*/
void ParameterGradient(const double * x , double * grad ) const {
return ParameterGradient(x, Parameters(), grad);
}
/**
Evaluate partial derivative using cached parameter values
*/
double ParameterDerivative(const double * x, unsigned int ipar = 0) const {
return DoParameterDerivative(x, Parameters() , ipar);
}
private:
/**
Evaluate the partial derivative w.r.t a parameter ipar , to be implemented by the derived classes
*/
virtual double DoParameterDerivative(const double * x, const double * p, unsigned int ipar) const = 0;
};
//_______________________________________________________________________________
/**
Interface (abstract class) for parametric one-dimensional gradient functions providing
in addition to function evaluation with respect the coordinates
also the gradient with respect to the parameters, via the method ParameterGradient.
It is a derived class from ROOT::Math::IParametricFunctionOneDim.
The pure private virtual method DoParameterGradient must be implemented by the derived classes
in addition to those inherited by the base abstract classes.
@ingroup ParamFunc
*/
class IParametricGradFunctionOneDim :
public IParametricFunctionOneDim
// ,public IGradientFunctionOneDim
{
public:
typedef IParametricFunctionOneDim BaseParamFunc;
typedef IGradientFunctionOneDim BaseGradFunc;
typedef IParametricFunctionOneDim::BaseFunc BaseFunc;
/**
Virtual Destructor (no operations)
*/
virtual ~IParametricGradFunctionOneDim () {}
using BaseParamFunc::operator();
/**
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
*/
virtual void ParameterGradient(double x , const double * p, double * grad ) const {
unsigned int npar = NPar();
for (unsigned int ipar = 0; ipar < npar; ++ipar)
grad[ipar] = DoParameterDerivative(x, p, ipar);
}
/**
Evaluate all derivatives using cached parameter values
*/
void ParameterGradient(double x , double * grad ) const {
return ParameterGradient( x, Parameters(), grad);
}
/**
Compatibility interface with multi-dimensional functions
*/
void ParameterGradient(const double * x , const double * p, double * grad ) const {
ParameterGradient(*x, p, grad);
}
/**
Evaluate all derivatives using cached parameter values (multi-dim like interface)
*/
void ParameterGradient(const double * x , double * grad ) const {
return ParameterGradient( *x, Parameters(), grad);
}
/**
Partial derivative with respect a parameter
*/
double ParameterDerivative(double x, const double * p, unsigned int ipar = 0) const {
return DoParameterDerivative(x, p, ipar);
}
/**
Evaluate partial derivative using cached parameter values
*/
double ParameterDerivative(double x, unsigned int ipar = 0) const {
return DoParameterDerivative(x, Parameters() , ipar);
}
/**
Partial derivative with respect a parameter
Compatibility interface with multi-dimensional functions
*/
double ParameterDerivative(const double * x, const double * p, unsigned int ipar = 0) const {
return DoParameterDerivative(*x, p, ipar);
}
/**
Evaluate partial derivative using cached parameter values (multi-dim like interface)
*/
double ParameterDerivative(const double * x, unsigned int ipar = 0) const {
return DoParameterDerivative( *x, Parameters() , ipar);
}
private:
/**
Evaluate the gradient, to be implemented by the derived classes
*/
virtual double DoParameterDerivative(double x, const double * p, unsigned int ipar ) const = 0;
};
} // end namespace Math
} // end namespace ROOT
#endif /* ROOT_Math_IParamFunction */
|