ROL::RangeSpaceOperator< Real > Class Template Reference

Projects on to the null space of a linear constraint. More...

#include <ROL_RangeSpaceOperator.hpp>

Inheritance diagram for ROL::RangeSpaceOperator< Real >:

Public Member Functions
virtual	~RangeSpaceOperator ()
	RangeSpaceOperator (const Ptr< Constraint< Real > > &con, const Ptr< const Vector< Real > > &dom, const Ptr< const Vector< Real > > &ran)
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
void	applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
void	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
void	applyAdjointInverse (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 Ptr< Constraint< Real > >	con_
const Ptr< Vector< Real > >	x_
Ptr< Vector< Real > >	b1_
Ptr< Vector< Real > >	b2_
Ptr< Vector< Real > >	mul_

Detailed Description

template<class Real>
class ROL::RangeSpaceOperator< Real >

Projects on to the null space of a linear constraint.

---

Definition at line 25 of file ROL_RangeSpaceOperator.hpp.

Constructor & Destructor Documentation

~RangeSpaceOperator()

template<class Real>

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

inlinevirtual

Definition at line 35 of file ROL_RangeSpaceOperator.hpp.

RangeSpaceOperator()

template<class Real>

ROL::RangeSpaceOperator< Real >::RangeSpaceOperator ( const Ptr< Constraint< Real > > & con, const Ptr< const Vector< Real > > & dom, const Ptr< const Vector< Real > > & ran )

inline

Definition at line 36 of file ROL_RangeSpaceOperator.hpp.

References b1_, b2_, con_, mul_, and x_.

Member Function Documentation

update()

template<class Real>

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

inlinevirtual

Definition at line 46 of file ROL_RangeSpaceOperator.hpp.

References x_.

apply()

template<class Real>

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

inlinevirtual

Definition at line 50 of file ROL_RangeSpaceOperator.hpp.

References b1_, b2_, con_, mul_, and x_.

applyAdjoint()

template<class Real>

void ROL::RangeSpaceOperator< Real >::applyAdjoint ( Vector< Real > & Hv, const Vector< Real > & v, Real & tol ) const

inline

Definition at line 55 of file ROL_RangeSpaceOperator.hpp.

applyInverse()

template<class Real>

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

inline

Definition at line 59 of file ROL_RangeSpaceOperator.hpp.

applyAdjointInverse()

template<class Real>

void ROL::RangeSpaceOperator< Real >::applyAdjointInverse ( Vector< Real > & Hv, const Vector< Real > & v, Real & tol ) const

inline

Definition at line 63 of file ROL_RangeSpaceOperator.hpp.

Member Data Documentation

con_

template<class Real>

const Ptr<Constraint<Real> > ROL::RangeSpaceOperator< Real >::con_

private

Definition at line 27 of file ROL_RangeSpaceOperator.hpp.

Referenced by apply(), and RangeSpaceOperator().

x_

template<class Real>

const Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::x_

private

Definition at line 28 of file ROL_RangeSpaceOperator.hpp.

Referenced by apply(), RangeSpaceOperator(), and update().

b1_

template<class Real>

Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::b1_

mutableprivate

Definition at line 30 of file ROL_RangeSpaceOperator.hpp.

Referenced by apply(), and RangeSpaceOperator().

b2_

template<class Real>

Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::b2_

mutableprivate

Definition at line 31 of file ROL_RangeSpaceOperator.hpp.

Referenced by apply(), and RangeSpaceOperator().

mul_

template<class Real>

Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::mul_

mutableprivate

Definition at line 32 of file ROL_RangeSpaceOperator.hpp.

Referenced by apply(), and RangeSpaceOperator().

---

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

• ROL_RangeSpaceOperator.hpp