Aristos  Development
 All Classes Functions Pages
Public Member Functions | List of all members
Aristos::LagMult Class Referenceabstract

Provides the interface for the evaluation of Lagrange multipliers. More...

#include <Aristos_LagMult.hpp>

Public Member Functions

virtual void getValue (const Vector &x, const Vector &g, Vector &l, double &tol) const =0
 Returns Lagrange multiplier estimate. More...
 

Detailed Description

Provides the interface for the evaluation of Lagrange multipliers.

Member Function Documentation

virtual void Aristos::LagMult::getValue ( const Vector x,
const Vector g,
Vector l,
double &  tol 
) const
pure virtual

Returns Lagrange multiplier estimate.

Parameters
x[in] - Current SQP iterate vector.
g[in] - The gradient of the objective function.
l[out] - The vector of Lagrange multiplier estimates.
tol[in] - Tolerance for inexact computations.
Returns
None.
Detailed Description:

Interface function that estimates the Lagrange multipliers. 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: