ROL
Public Member Functions | Private Attributes | List of all members
ROL::NewtonKrylovStep< Real >::HessianNK Class Reference
+ Inheritance diagram for ROL::NewtonKrylovStep< Real >::HessianNK:

Public Member Functions

 HessianNK (const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< Vector< Real > > &x)
 
void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply linear operator. More...
 
- Public Member Functions inherited from ROL::LinearOperator< Real >
virtual ~LinearOperator ()
 
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update linear operator. More...
 
virtual void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply inverse of linear operator. More...
 
virtual void applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of linear operator. More...
 
virtual void applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of the inverse linear operator. More...
 

Private Attributes

const ROL::Ptr< Objective< Real > > obj_
 
const ROL::Ptr< Vector< Real > > x_
 

Detailed Description

template<class Real>
class ROL::NewtonKrylovStep< Real >::HessianNK

Definition at line 88 of file ROL_NewtonKrylovStep.hpp.

Constructor & Destructor Documentation

template<class Real >
ROL::NewtonKrylovStep< Real >::HessianNK::HessianNK ( const ROL::Ptr< Objective< Real > > &  obj,
const ROL::Ptr< Vector< Real > > &  x 
)
inline

Definition at line 93 of file ROL_NewtonKrylovStep.hpp.

Member Function Documentation

template<class Real >
void ROL::NewtonKrylovStep< Real >::HessianNK::apply ( Vector< Real > &  Hv,
const Vector< Real > &  v,
Real &  tol 
) const
inlinevirtual

Apply linear operator.

This function applies the linear operator to a vector.

Parameters
[out]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Implements ROL::LinearOperator< Real >.

Definition at line 95 of file ROL_NewtonKrylovStep.hpp.

References ROL::NewtonKrylovStep< Real >::HessianNK::obj_, and ROL::NewtonKrylovStep< Real >::HessianNK::x_.

Member Data Documentation

template<class Real >
const ROL::Ptr<Objective<Real> > ROL::NewtonKrylovStep< Real >::HessianNK::obj_
private
template<class Real >
const ROL::Ptr<Vector<Real> > ROL::NewtonKrylovStep< Real >::HessianNK::x_
private

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