Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

Anaphe::IFunction Class Reference

#include <IFunction.h>

Inheritance diagram for Anaphe::IFunction:

Anaphe::IModelFunction Anaphe::IObjectiveFunction List of all members.

Public Methods

virtual double value (const std::vector< double > &x) const=0
 Scalar value of the function.

virtual const std::vector<
double > & 
grad (const std::vector< double > &x) const=0
 Gradient of the function. The result is valid only if hasGradient()==true. Otherwise the result is some default (empty) data-point.

virtual bool hasGradient () const=0
 Determine whether function is able to compute gradient.

virtual int dimension () const=0
 Dimensionality of the domain space.

virtual void toAscii (std_ostream &os) const=0
 Dump textual representation on output stream.

virtual bool isEqual (const IFunction *f) const=0
 Compare if functions are the same. PENDING: define exactly what it means.

virtual ~IFunction ()

Constructor & Destructor Documentation

virtual Anaphe::IFunction::~IFunction   [inline, virtual]
 


Member Function Documentation

virtual int Anaphe::IFunction::dimension   const [pure virtual]
 

virtual const std::vector<double>& Anaphe::IFunction::grad const std::vector< double > &    x const [pure virtual]
 

virtual bool Anaphe::IFunction::hasGradient   const [pure virtual]
 

virtual bool Anaphe::IFunction::isEqual const IFunction *    f const [pure virtual]
 

virtual void Anaphe::IFunction::toAscii std_ostream   os const [pure virtual]
 

virtual double Anaphe::IFunction::value const std::vector< double > &    x const [pure virtual]
 


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

Anaphe documentation generated by Doxygen (www.doxygen.org)