ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK Class Reference

Inheritance diagram for ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK:

Public Member Functions
	PrecondPNK (const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< BoundConstraint< Real > > &bnd, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< Vector< Real > > &g, Real eps=0)
	PrecondPNK (const ROL::Ptr< Secant< Real > > &secant, const ROL::Ptr< BoundConstraint< Real > > &bnd, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< Vector< Real > > &g, Real eps=0)
void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply linear operator. More...
void	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply inverse of 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	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< Secant< Real > >	secant_
const ROL::Ptr < BoundConstraint< Real > >	bnd_
const ROL::Ptr< Vector< Real > >	x_
const ROL::Ptr< Vector< Real > >	g_
ROL::Ptr< Vector< Real > >	v_
Real	eps_
const bool	useSecant_

Detailed Description

template<class Real>
class ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK

Definition at line 84 of file ROL_ProjectedNewtonKrylovStep.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::PrecondPNK ( const ROL::Ptr< Objective< Real > > &  obj, const ROL::Ptr< BoundConstraint< Real > > &  bnd, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< Vector< Real > > &  g, Real  eps = 0  )

inline

Definition at line 95 of file ROL_ProjectedNewtonKrylovStep.hpp.

References ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::v_, and ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::x_.

template<class Real >

ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::PrecondPNK ( const ROL::Ptr< Secant< Real > > &  secant, const ROL::Ptr< BoundConstraint< Real > > &  bnd, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< Vector< Real > > &  g, Real  eps = 0  )

inline

Definition at line 103 of file ROL_ProjectedNewtonKrylovStep.hpp.

References ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::v_, and ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::x_.

Member Function Documentation

template<class Real >

void ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::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]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Implements ROL::LinearOperator< Real >.

Definition at line 111 of file ROL_ProjectedNewtonKrylovStep.hpp.

References ROL::Vector< Real >::dual(), and ROL::Vector< Real >::set().

template<class Real >

void ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse ( Vector< Real > &  Hv, const Vector< Real > &  v, Real &  tol  ) const

inlinevirtual

Apply inverse of linear operator.

This function applies the inverse of linear operator to a vector.

Parameters

[out]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 114 of file ROL_ProjectedNewtonKrylovStep.hpp.

References ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::bnd_, ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::eps_, ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::g_, ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::obj_, ROL::Vector< Real >::plus(), ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::secant_, ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::useSecant_, ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::v_, and ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::x_.

Member Data Documentation

template<class Real >

const ROL::Ptr<Objective<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::obj_

private

Definition at line 86 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse().

template<class Real >

const ROL::Ptr<Secant<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::secant_

private

Definition at line 87 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse().

template<class Real >

const ROL::Ptr<BoundConstraint<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::bnd_

private

Definition at line 88 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse().

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::x_

private

Definition at line 89 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse(), and ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::PrecondPNK().

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::g_

private

Definition at line 90 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse().

template<class Real >

ROL::Ptr<Vector<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::v_

private

Definition at line 91 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse(), and ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::PrecondPNK().

template<class Real >

Real ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::eps_

private

Definition at line 92 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse().

template<class Real >

const bool ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::useSecant_

private

Definition at line 93 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse().

---

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

• ROL_ProjectedNewtonKrylovStep.hpp