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

Public Member Functions

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.
 

Member Function Documentation

void * IFunctionROOT::cast ( const std::string &  className) const
virtual

See IManagedObject for a description.

Parameters
classNameThe name of the class to cast on.
Returns
The right pointer. Return 0 if failure.

Implements AIDA::IFunction.

std::string IFunctionROOT::codeletString ( ) const
virtual

String describing the metatype and implementation of the function.

Generic format of the string:

codelet:TYPE:LOCATION

TYPE part contains only a 'typename' string which is a metatype identifier (used in plugins and catalogues)

LOCATION may be: 'file', 'verbatim', or 'catalogue'

Detailed description:

codelet:typename - no location specified (using 'catalogue')

codelet:typename:file:/filename.cpp - a c++ source file codelet:typename:file:/filename.py - a python source file codelet:typename:file:/filename.so - a shared library

codelet:typename:catalogue - entry in a catalogue repository

codelet:typename:verbatim:cpp
- c++ source file included verbatim after
codelet:typename:verbatim:py
- python source file included verbatim aftern

Comments:

file:/filename is a relative path to $AIDA_FUNCTION_DEFAULT_DIR file://filename is an absolute path

Examples:

codelet:G:catalogue codelet:userSinus:verbatim:cpp
{ return sin(x); }

Implements AIDA::IFunction.

const std::vector< double > & IFunctionROOT::gradient ( const std::vector< double > &  x) const
virtual

Gradient of the function.

The result is valid only if providesGradient()==true. Otherwise the result is some default (empty) vector.

Implements AIDA::IFunction.

int IFunctionROOT::indexOfParameter ( const std::string &  name) const
virtual

Return -1 if parameter not found (name undefined).

Leave it because there are use cases - some users prefer to use numbers.

Implements AIDA::IFunction.

bool IFunctionROOT::isEqual ( const IFunction f) const
virtual

Compare if functions are the same.

PENDING: define exactly what it means ;)

Implements AIDA::IFunction.

std::vector< std::string > IFunctionROOT::parameterNames ( ) const
virtual

Names of paramaters.

Names should be unique. Case-insensitive for comparison. Case-sensitive for storage and output. All or several names may be left blank "" if the implementation does not want to provide them.

Implements AIDA::IFunction.

bool IFunctionROOT::setParameter ( const std::string &  name,
double  x 
)
virtual

Set parameter's value by name.

Parameters
nameThe name of the parameter.
xThe new value of the parameter.
Returns
false If name does not correspond to a parameter.

Implements AIDA::IFunction.

bool IFunctionROOT::setTitle ( const std::string &  title)
virtual

Set the histogram title.

Parameters
titleThe title.
Returns
false If title cannot be changed.

Implements AIDA::IFunction.

std::string IFunctionROOT::title ( ) const
virtual

Get the Function's title.

Returns
The Function's title.

Implements AIDA::IFunction.


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