Provides interfaces for the evaluation of quantities related to the objective function. More...

#include <Aristos_Objective.hpp>

Public Member Functions
virtual double	getValue (const Vector &x) const =0
	Returns the value of the objective function. More...

virtual void	getGradient (const Vector &x, Vector &g) const =0
	Computes the gradient of the objective function. More...

Detailed Description

Provides interfaces for the evaluation of quantities related to the objective function.

These include:

Member Function Documentation

virtual void Aristos::Objective::getGradient	(	const Vector &	x,
		Vector &	g
	)		const

pure virtual

Computes the gradient of the objective function.

Parameters

x	[in] - Current SQP iterate vector.
g	[out] - Gradient of the objective function.

Interface function that evaluates the gradient of the objective function. To be subclassed and implemented by the user.

Note: The Aristos::Vector input parameters can be recast into user-accessible quantities by using the following syntax (this is only one example):
Teuchos::RefCountPtr<const YourVectorClass> ex = (Teuchos::dyn_cast<Aristos::YourVectorAdapter>(const_cast<Aristos::Vector&>(x))).getVector();

virtual double Aristos::Objective::getValue ( const Vector & x ) const

pure virtual

Returns the value of the objective function.

Parameters

x	[in] - Current SQP iterate vector.

Interface function that evaluates the objective function. To be subclassed and implemented by the user.

Note: The Aristos::Vector input parameters can be recast into user-accessible quantities by using the following syntax (this is only one example):
Teuchos::RefCountPtr<const YourVectorClass> ex = (Teuchos::dyn_cast<Aristos::YourVectorAdapter>(const_cast<Aristos::Vector&>(x))).getVector();

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