ROL::LinearOperatorSum< Real > Class Template Reference

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

#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)
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 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.

autotoc_md36

Definition at line 25 of file ROL_LinearOperatorSum.hpp.

Member Typedef Documentation

V

template<class Real>

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

private

Definition at line 27 of file ROL_LinearOperatorSum.hpp.

OP

template<class Real>

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

private

Definition at line 28 of file ROL_LinearOperatorSum.hpp.

size_type

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

LinearOperatorSum() [1/2]

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 ops_, and scratch_.

LinearOperatorSum() [2/2]

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 ops_, and scratch_.

Member Function Documentation

update()

template<class Real>

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

inlinevirtual

Definition at line 61 of file ROL_LinearOperatorSum.hpp.

References ops_.

apply()

template<class Real>

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

inlinevirtual

Definition at line 67 of file ROL_LinearOperatorSum.hpp.

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

applyInverse()

template<class Real>

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

inlinevirtual

Definition at line 75 of file ROL_LinearOperatorSum.hpp.

Member Data Documentation

ops_

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 apply(), LinearOperatorSum(), LinearOperatorSum(), and update().

scratch_

template<class Real>

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

private

Definition at line 35 of file ROL_LinearOperatorSum.hpp.

Referenced by apply(), LinearOperatorSum(), and LinearOperatorSum().

---

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

• ROL_LinearOperatorSum.hpp