RAIDA  1.9.0
Public Member Functions | List of all members
AIDA::IModelFunctionROOT Class Reference
Inheritance diagram for AIDA::IModelFunctionROOT:
AIDA::IFunctionROOT AIDA::IModelFunction AIDA::IFunction AIDA::IFunction

Public Member Functions

virtual ~IModelFunctionROOT ()
 Destructor.
 
virtual bool providesNormalization () const
 Return false if function does not provide the normalization capability.
 
virtual void normalize (bool on)
 Normalize by internally adjusting some of the parameters. More...
 
virtual bool isNormalized () const
 Return true if normalization is currently switched on.
 
virtual const std::vector
< double > & 
parameterGradient (const std::vector< double > &x) const
 Compute gradient with respect to parameters.
 
virtual bool providesParameterGradient () const
 Return true if provides parameter gradient.
 
virtual IRangeSetnormalizationRange (int iAxis)
 Set the normalization range from -inf to +inf in the i-th axis (dimension). More...
 
virtual void includeNormalizationAll ()
 Set full range in all axes.
 
virtual void excludeNormalizationAll ()
 Set empty range in all axes.
 
- Public Member Functions inherited from AIDA::IFunctionROOT
virtual ~IFunctionROOT ()
 Destructor.
 
virtual std::string title () const
 Get the Function's title. More...
 
virtual bool setTitle (const std::string &title)
 Set the histogram title. More...
 
virtual double value (const std::vector< double > &x) const
 Scalar value of the function.
 
virtual int dimension () const
 Dimensionality of the domain space.
 
virtual bool isEqual (const IFunction &f) const
 Compare if functions are the same. More...
 
virtual const std::vector
< double > & 
gradient (const std::vector< double > &x) const
 Gradient of the function. More...
 
virtual bool providesGradient () const
 Determine whether function is able to compute gradient.
 
virtual std::string variableName (int i) const
 Get the symbolic name of i-th variable.
 
virtual std::vector< std::string > variableNames () const
 Get all the names in a vector.
 
virtual bool setParameters (const std::vector< double > &params)
 Set new vector of parameters.
 
virtual const std::vector
< double > & 
parameters () const
 Retrieve current vector of parameters.
 
virtual int numberOfParameters () const
 Number of parameters.
 
virtual std::vector< std::string > parameterNames () const
 Names of paramaters. More...
 
virtual bool setParameter (const std::string &name, double x)
 Set parameter's value by name. More...
 
virtual double parameter (const std::string &name) const
 
virtual int indexOfParameter (const std::string &name) const
 Return -1 if parameter not found (name undefined). More...
 
virtual IAnnotationannotation ()
 
virtual const IAnnotationannotation () const
 
virtual std::string codeletString () const
 String describing the metatype and implementation of the function. More...
 
virtual void * cast (const std::string &className) const
 See IManagedObject for a description. More...
 
- Public Member Functions inherited from AIDA::IFunction
virtual ~IFunction ()
 Destructor.
 
- Public Member Functions inherited from AIDA::IModelFunction
virtual ~IModelFunction ()
 Destructor.
 

Member Function Documentation

IRangeSet & IModelFunctionROOT::normalizationRange ( int  iAxis)
virtual

Set the normalization range from -inf to +inf in the i-th axis (dimension).

Full range is the default if not set otherwise. It is still possible to evaluate function outside of the normalization range.

PENDING: no methods to retrieve current range!

Implements AIDA::IModelFunction.

void IModelFunctionROOT::normalize ( bool  on)
virtual

Normalize by internally adjusting some of the parameters.

When normalization is on then integral of the function in the normalization range equals to 1.

Implements AIDA::IModelFunction.


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