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

Provides the interface for the evaluation of Hessian-of-Lagrangian times vector products. More...

#include <Aristos_HessVec.hpp>

Public Member Functions

virtual void getValue (const Vector &x, const Vector &l, const Vector &s, Vector &Hs) const =0
 Returns Hessian-of-Lagrangian times vector product. More...
 

Detailed Description

Provides the interface for the evaluation of Hessian-of-Lagrangian times vector products.

Member Function Documentation

virtual void Aristos::HessVec::getValue ( const Vector x,
const Vector l,
const Vector s,
Vector Hs 
) const
pure virtual

Returns Hessian-of-Lagrangian times vector product.

Parameters
x[in] - Current SQP iterate vector.
l[in] - The vector of Lagrange multipliers.
s[in] - The vector to which the Hessian-of-Lagrangian operator is applied.
Hs[out] - Resulting vector.
Returns
None.
Detailed Description:

Interface function that evaluates the vector obtained by applying the Hessian-of-Lagrangian operator to a vector. 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: