ObjectiveFunction Class Reference

#include <ObjectiveFunction.h>

Inheritance diagram for ObjectiveFunction:

Public Member Functions
	ObjectiveFunction (const Parameters &paramsPassed)
virtual	~ObjectiveFunction ()
virtual double	getEnergy ()=0
virtual VectorXd	getGradient (bool fdstep=false)=0
virtual void	setPositions (const VectorXd &x)=0
virtual VectorXd	getPositions ()=0
virtual int	degreesOfFreedom ()=0
virtual bool	isConverged ()=0
virtual double	getConvergence ()=0
virtual VectorXd	difference (const VectorXd &a, const VectorXd &b)=0

Protected Attributes
const Parameters &	params

Detailed Description

Definition at line 18 of file ObjectiveFunction.h.

Constructor & Destructor Documentation

ObjectiveFunction()

eonc::ObjectiveFunction::ObjectiveFunction ( const Parameters & paramsPassed )

inline

Definition at line 23 of file ObjectiveFunction.h.

      : params{paramsPassed} {}

~ObjectiveFunction()

virtual eonc::ObjectiveFunction::~ObjectiveFunction ( )

inlinevirtual

Definition at line 25 of file ObjectiveFunction.h.

{}

Member Function Documentation

degreesOfFreedom()

virtual int eonc::ObjectiveFunction::degreesOfFreedom ( )

pure virtual

difference()

virtual VectorXd eonc::ObjectiveFunction::difference ( const VectorXd & a, const VectorXd & b )

pure virtual

getConvergence()

virtual double eonc::ObjectiveFunction::getConvergence ( )

pure virtual

getEnergy()

virtual double eonc::ObjectiveFunction::getEnergy ( )

pure virtual

getGradient()

virtual VectorXd eonc::ObjectiveFunction::getGradient ( bool fdstep = false )

pure virtual

getPositions()

virtual VectorXd eonc::ObjectiveFunction::getPositions ( )

pure virtual

isConverged()

virtual bool eonc::ObjectiveFunction::isConverged ( )

pure virtual

setPositions()

virtual void eonc::ObjectiveFunction::setPositions ( const VectorXd & x )

pure virtual

Member Data Documentation

params

const Parameters& eonc::ObjectiveFunction::params

protected

Definition at line 20 of file ObjectiveFunction.h.

---

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

• /home/runner/work/eOn/eOn/include/eon/ObjectiveFunction.h