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

ROL

Multiplication by unity. More...

#include <ROL_IdentityOperator.hpp>

Inheritance diagram for ROL::IdentityOperator< Real >:

Private Member Functions
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...

Additional Inherited Members
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...

Detailed Description

template<class Real>
class ROL::IdentityOperator< Real >

Multiplication by unity.

Definition at line 24 of file ROL_IdentityOperator.hpp.

Member Function Documentation

template<class Real >

void ROL::IdentityOperator< Real >::apply	(	Vector< Real > &	Hv,
		const Vector< Real > &	v,
		Real &	tol
	)		const

inlineprivatevirtual

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 26 of file ROL_IdentityOperator.hpp.

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

template<class Real >

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

inlineprivatevirtual

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 30 of file ROL_IdentityOperator.hpp.

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

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

ROL_IdentityOperator.hpp