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

ROL

Provides the interface to sum of linear operators applied to a vector

#include <ROL_LinearOperatorSum.hpp>

Inheritance diagram for ROL::LinearOperatorSum< Real >:

Public Member Functions
	LinearOperatorSum (ROL::Ptr< OP > &A, ROL::Ptr< OP > &B, ROL::Ptr< V > &scratch)

	LinearOperatorSum (ROL::Ptr< OP > &A, ROL::Ptr< OP > &B, ROL::Ptr< OP > &C, ROL::Ptr< V > &scratch)

virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update linear operator. More...

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	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 Types
typedef Vector< Real >	V

typedef LinearOperator< Real >	OP

typedef std::vector< ROL::Ptr < OP > >::size_type	size_type

Private Attributes
ROL::Ptr< std::vector < ROL::Ptr< OP > > >	ops_

ROL::Ptr< V >	scratch_

Detailed Description

template<class Real>
class ROL::LinearOperatorSum< Real >

Provides the interface to sum of linear operators applied to a vector

Definition at line 25 of file ROL_LinearOperatorSum.hpp.

Member Typedef Documentation

template<class Real >

typedef Vector<Real> ROL::LinearOperatorSum< Real >::V

private

Definition at line 27 of file ROL_LinearOperatorSum.hpp.

template<class Real >

typedef LinearOperator<Real> ROL::LinearOperatorSum< Real >::OP

private

Definition at line 28 of file ROL_LinearOperatorSum.hpp.

template<class Real >

typedef std::vector<ROL::Ptr<OP> >::size_type ROL::LinearOperatorSum< Real >::size_type

private

Definition at line 30 of file ROL_LinearOperatorSum.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::LinearOperatorSum< Real >::LinearOperatorSum	(	ROL::Ptr< OP > &	A,
		ROL::Ptr< OP > &	B,
		ROL::Ptr< V > &	scratch
	)

inline

Definition at line 39 of file ROL_LinearOperatorSum.hpp.

References ROL::LinearOperatorSum< Real >::ops_.

template<class Real >

ROL::LinearOperatorSum< Real >::LinearOperatorSum	(	ROL::Ptr< OP > &	A,
		ROL::Ptr< OP > &	B,
		ROL::Ptr< OP > &	C,
		ROL::Ptr< V > &	scratch
	)

inline

Definition at line 48 of file ROL_LinearOperatorSum.hpp.

References ROL::LinearOperatorSum< Real >::ops_.

Member Function Documentation

template<class Real >

virtual void ROL::LinearOperatorSum< Real >::update	(	const Vector< Real > &	x,
		bool	flag = `true`,
		int	iter = `-1`
	)

inlinevirtual

Update linear operator.

This function updates the linear operator at new iterations.

Parameters

[in]	x	is the new iterate.
[in]	flag	is true if the iterate has changed.
[in]	iter	is the outer algorithm iterations count.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 61 of file ROL_LinearOperatorSum.hpp.

References ROL::LinearOperatorSum< Real >::ops_.

template<class Real >

virtual void ROL::LinearOperatorSum< 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 67 of file ROL_LinearOperatorSum.hpp.

References ROL::LinearOperatorSum< Real >::ops_, ROL::Vector< Real >::plus(), and ROL::LinearOperatorSum< Real >::scratch_.

template<class Real >

virtual void ROL::LinearOperatorSum< 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 75 of file ROL_LinearOperatorSum.hpp.

Member Data Documentation

template<class Real >

ROL::Ptr<std::vector<ROL::Ptr<OP> > > ROL::LinearOperatorSum< Real >::ops_

private

Definition at line 34 of file ROL_LinearOperatorSum.hpp.

Referenced by ROL::LinearOperatorSum< Real >::apply(), ROL::LinearOperatorSum< Real >::LinearOperatorSum(), and ROL::LinearOperatorSum< Real >::update().

template<class Real >

ROL::Ptr<V> ROL::LinearOperatorSum< Real >::scratch_

private

Definition at line 35 of file ROL_LinearOperatorSum.hpp.

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

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

ROL_LinearOperatorSum.hpp