ROL: ROL::LinearOperatorFromConstraint< Real > Class Template Reference

ROL

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
	Apply linear operator. More...

virtual 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< 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

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.

template<class Real >

virtual ROL::LinearOperatorFromConstraint< Real >::~LinearOperatorFromConstraint ( )

inlinevirtual

Definition at line 42 of file ROL_LinearOperatorFromConstraint.hpp.

Member Function Documentation

template<class Real >

virtual void ROL::LinearOperatorFromConstraint< Real >::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 44 of file ROL_LinearOperatorFromConstraint.hpp.

References ROL::LinearOperatorFromConstraint< Real >::con_, and ROL::LinearOperatorFromConstraint< Real >::x_.

template<class Real >

virtual void ROL::LinearOperatorFromConstraint< Real >::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 49 of file ROL_LinearOperatorFromConstraint.hpp.

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

Member Data Documentation

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 ROL::LinearOperatorFromConstraint< Real >::apply().

template<class Real >

ROL::Ptr<Constraint<Real> > ROL::LinearOperatorFromConstraint< Real >::con_

private

Definition at line 32 of file ROL_LinearOperatorFromConstraint.hpp.

Referenced by ROL::LinearOperatorFromConstraint< Real >::apply().

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

ROL_LinearOperatorFromConstraint.hpp