CERN Accelerating science

• Sign in
• Directory

This website is no longer maintained. Its content may be obsolete. Please visit http://home.cern/ for current CERN information.

           

---

IBasicFunction Class Reference

#include <IBasicFunction.h>

Inheritance diagram for IBasicFunction:

List of all members.

Public Methods
virtual string	description ()=0
virtual void	setDescription (string description)=0
virtual double	value (const std::vector< double > &x) const=0
virtual const std::vector< double > &	grad (const std::vector< double > &x) const=0
virtual bool	hasGradient () const=0
virtual int	dimension () const=0
virtual void	toXML (std_ostream &os) const=0
virtual bool	isEqual (const IBasicFunction *f) const=0
virtual IBasicFunction *	clone ()=0
virtual	~IBasicFunction ()

---

Constructor & Destructor Documentation

virtual IBasicFunction::~IBasicFunction (    )  [inline, virtual]

---

Member Function Documentation

virtual string IBasicFunction::description (    )  [pure virtual]

virtual void IBasicFunction::setDescription (  string    description )  [pure virtual]

virtual double IBasicFunction::value (  const std::vector< double > &    x )  const [pure virtual]

Scalar value of the function.

virtual const std::vector<double>& IBasicFunction::grad (  const std::vector< double > &    x )  const [pure virtual]

Gradient of the function. The result is valid only if hasGradient()==true. Otherwise the result is some default (empty) data-point.

virtual bool IBasicFunction::hasGradient (    )  const [pure virtual]

Determine whether function is able to compute gradient.

virtual int IBasicFunction::dimension (    )  const [pure virtual]

Dimensionality of the domain space.

virtual void IBasicFunction::toXML (  std_ostream &    os )  const [pure virtual]

Dump textual representation on output stream.

virtual bool IBasicFunction::isEqual (  const IBasicFunction *    f )  const [pure virtual]

Compare if functions are the same. PENDING: define exactly what it means

virtual IBasicFunction* IBasicFunction::clone (    )  [pure virtual]

---