DFLib::Abstract::Group Class Reference

#include <Util_Abstract_Group.hpp>

Inheritance diagram for DFLib::Abstract::Group:

Public Member Functions
virtual	~Group ()
	Provide a virtual destructor. More...
virtual void	setEvaluationPoint (std::vector< double > &ep)=0
	Set the point at which to evaluate the function. More...
virtual double	getFunctionValue ()=0
virtual double	getFunctionValueAndGradient (std::vector< double > &gradient)=0
virtual double	getFunctionValueAndHessian (std::vector< double > &gradient, std::vector< std::vector< double > > &hessian)=0

Constructor & Destructor Documentation

virtual DFLib::Abstract::Group::~Group ( )

inlinevirtual

Provide a virtual destructor.

Member Function Documentation

virtual double DFLib::Abstract::Group::getFunctionValue ( )

pure virtual

evaluate the function at the evaluation point

Returns

value of function

Implemented in DFLib::ReportCollection.

Here is the caller graph for this function:

virtual double DFLib::Abstract::Group::getFunctionValueAndGradient ( std::vector< double > &  gradient )

pure virtual

evaluate the function and its gradient at the evaluation point

Parameters

gradient

STL vector containing gradient on return

Returns

value of function

Implemented in DFLib::ReportCollection.

Here is the caller graph for this function:

virtual double DFLib::Abstract::Group::getFunctionValueAndHessian ( std::vector< double > &  gradient, std::vector< std::vector< double > > &  hessian  )

pure virtual

evaluate the function and its gradient at the evaluation point

Parameters

gradient	STL vector containing gradient on return
hessian	contains hessian on return

Returns

value of function

Implemented in DFLib::ReportCollection.

virtual void DFLib::Abstract::Group::setEvaluationPoint ( std::vector< double > &  ep )

pure virtual

Set the point at which to evaluate the function.

Implemented in DFLib::ReportCollection.

Here is the caller graph for this function:

---

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

• /users/russo/DFLIB_Git/DFLib/Util_Abstract_Group.hpp