ROL
ROL::LinearOperatorFromConstraint< Real > Class Template Reference

A simple wrapper which allows application of constraint Jacobians through the LinearOperator interface. More...

#include <ROL_LinearOperatorFromConstraint.hpp>

Inheritance diagram for ROL::LinearOperatorFromConstraint< Real >:

Public Member Functions

 LinearOperatorFromConstraint (const ROL::Ptr< const Vector< Real > > &x, const ROL::Ptr< Constraint< Real > > &con)
virtual ~LinearOperatorFromConstraint ()
virtual void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
virtual 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< const Vector< Real > > x_
ROL::Ptr< Constraint< Real > > con_

Detailed Description

template<class Real>
class ROL::LinearOperatorFromConstraint< Real >

A simple wrapper which allows application of constraint Jacobians through the LinearOperator interface.


Definition at line 29 of file ROL_LinearOperatorFromConstraint.hpp.

Constructor & Destructor Documentation

◆ LinearOperatorFromConstraint()

template<class Real>
ROL::LinearOperatorFromConstraint< Real >::LinearOperatorFromConstraint ( const ROL::Ptr< const Vector< Real > > & x,
const ROL::Ptr< Constraint< Real > > & con )
inline

Definition at line 37 of file ROL_LinearOperatorFromConstraint.hpp.

References con_, and x_.

◆ ~LinearOperatorFromConstraint()

template<class Real>
virtual ROL::LinearOperatorFromConstraint< Real >::~LinearOperatorFromConstraint ( )
inlinevirtual

Definition at line 42 of file ROL_LinearOperatorFromConstraint.hpp.

Member Function Documentation

◆ apply()

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

Definition at line 44 of file ROL_LinearOperatorFromConstraint.hpp.

References con_, and x_.

◆ applyInverse()

template<class Real>
virtual void ROL::LinearOperatorFromConstraint< Real >::applyInverse ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inlinevirtual

Definition at line 49 of file ROL_LinearOperatorFromConstraint.hpp.

References ROL::Vector< Real >::set().

Member Data Documentation

◆ x_

template<class Real>
const ROL::Ptr<const Vector<Real> > ROL::LinearOperatorFromConstraint< Real >::x_
private

Definition at line 31 of file ROL_LinearOperatorFromConstraint.hpp.

Referenced by apply(), and LinearOperatorFromConstraint().

◆ con_

template<class Real>
ROL::Ptr<Constraint<Real> > ROL::LinearOperatorFromConstraint< Real >::con_
private

Definition at line 32 of file ROL_LinearOperatorFromConstraint.hpp.

Referenced by apply(), and LinearOperatorFromConstraint().


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