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

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

◆ PrecondPD()

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 bnd_, eps_, obj_, secant_, useSecant_, v_, x_, and xlam_.

Member Function Documentation

◆ apply()

template<class Real>
void ROL::PrimalDualActiveSetStep< Real >::PrecondPD::apply ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inline

◆ applyInverse()

template<class Real>
void ROL::PrimalDualActiveSetStep< Real >::PrecondPD::applyInverse ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inline

Definition at line 202 of file ROL_PrimalDualActiveSetStep.hpp.

References bnd_, eps_, obj_, secant_, useSecant_, v_, x_, and xlam_.

Member Data Documentation

◆ obj_

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 applyInverse(), and PrecondPD().

◆ bnd_

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 applyInverse(), and PrecondPD().

◆ x_

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 applyInverse(), and PrecondPD().

◆ xlam_

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 applyInverse(), and PrecondPD().

◆ v_

template<class Real>
ROL::Ptr<Vector<Real> > ROL::PrimalDualActiveSetStep< Real >::PrecondPD::v_
private

Definition at line 180 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by applyInverse(), and PrecondPD().

◆ eps_

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

Definition at line 181 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by applyInverse(), and PrecondPD().

◆ secant_

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 applyInverse(), and PrecondPD().

◆ useSecant_

template<class Real>
bool ROL::PrimalDualActiveSetStep< Real >::PrecondPD::useSecant_
private

Definition at line 183 of file ROL_PrimalDualActiveSetStep.hpp.

Referenced by applyInverse(), and PrecondPD().


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