ROL::PrimalDualActiveSetStep< Real >::PrecondPD Class Reference

Inheritance diagram for ROL::PrimalDualActiveSetStep< Real >::PrecondPD:

Public Member Functions
	PrecondPD (const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< BoundConstraint< Real > > &bnd, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< Vector< Real > > &xlam, const Real eps=0, const ROL::Ptr< Secant< Real > > &secant=ROL::nullPtr, const bool useSecant=false)
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 < BoundConstraint< Real > >	bnd_
const ROL::Ptr< Vector< Real > >	x_
const ROL::Ptr< Vector< Real > >	xlam_
ROL::Ptr< Vector< Real > >	v_
Real	eps_
const ROL::Ptr< Secant< Real > >	secant_
bool	useSecant_

Detailed Description

template<class Real>
class ROL::PrimalDualActiveSetStep< Real >::PrecondPD

Definition at line 174 of file ROL_PrimalDualActiveSetStep.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::PrimalDualActiveSetStep< Real >::PrecondPD::PrecondPD ( const ROL::Ptr< Objective< Real > > &  obj, const ROL::Ptr< BoundConstraint< Real > > &  bnd, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< Vector< Real > > &  xlam, const Real  eps = 0, const ROL::Ptr< Secant< Real > > &  secant = ROL::nullPtr, const bool  useSecant = false  )

inline

Definition at line 185 of file ROL_PrimalDualActiveSetStep.hpp.

References ROL::PrimalDualActiveSetStep< Real >::PrecondPD::useSecant_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::v_, and ROL::PrimalDualActiveSetStep< Real >::PrecondPD::x_.

Member Function Documentation

template<class Real >

void ROL::PrimalDualActiveSetStep< Real >::PrecondPD::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 199 of file ROL_PrimalDualActiveSetStep.hpp.

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

template<class Real >

void ROL::PrimalDualActiveSetStep< Real >::PrecondPD::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 202 of file ROL_PrimalDualActiveSetStep.hpp.

References ROL::PrimalDualActiveSetStep< Real >::PrecondPD::bnd_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::eps_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::obj_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::secant_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::useSecant_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::v_, ROL::PrimalDualActiveSetStep< Real >::PrecondPD::x_, and ROL::PrimalDualActiveSetStep< Real >::PrecondPD::xlam_.

Member Data Documentation

template<class Real >

const ROL::Ptr<Objective<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::obj_

private

Definition at line 176 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse().

template<class Real >

const ROL::Ptr<BoundConstraint<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::bnd_

private

Definition at line 177 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse().

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::x_

private

Definition at line 178 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse(), and ROL::PrimalDualActiveSetStep< Real >::PrecondPD::PrecondPD().

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::xlam_

private

Definition at line 179 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse().

template<class Real >

ROL::Ptr<Vector<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::v_

private

Definition at line 180 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse(), and ROL::PrimalDualActiveSetStep< Real >::PrecondPD::PrecondPD().

template<class Real >

Real ROL::PrimalDualActiveSetStep< Real >::PrecondPD::eps_

private

Definition at line 181 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse().

template<class Real >

const ROL::Ptr<Secant<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::secant_

private

Definition at line 182 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse().

template<class Real >

bool ROL::PrimalDualActiveSetStep< Real >::PrecondPD::useSecant_

private

Definition at line 183 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse(), and ROL::PrimalDualActiveSetStep< Real >::PrecondPD::PrecondPD().

---

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

• ROL_PrimalDualActiveSetStep.hpp