ROL
Public Member Functions | Private Attributes | List of all members
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)
 Update linear operator. More...
 
virtual void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply linear operator. More...
 
void applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of linear operator. More...
 
void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply inverse of linear operator. More...
 
void applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of the inverse linear operator. More...
 
- Public Member Functions inherited from ROL::LinearOperator< Real >
virtual ~LinearOperator ()
 

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

template<class Real>
virtual ROL::RangeSpaceOperator< Real >::~RangeSpaceOperator ( )
inlinevirtual

Definition at line 35 of file ROL_RangeSpaceOperator.hpp.

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

Member Function Documentation

template<class Real>
virtual void ROL::RangeSpaceOperator< 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]xis the new iterate.
[in]flagis true if the iterate has changed.
[in]iteris the outer algorithm iterations count.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 46 of file ROL_RangeSpaceOperator.hpp.

References ROL::RangeSpaceOperator< Real >::x_.

template<class Real>
virtual void ROL::RangeSpaceOperator< 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]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Implements ROL::LinearOperator< Real >.

Definition at line 50 of file ROL_RangeSpaceOperator.hpp.

References ROL::RangeSpaceOperator< Real >::b1_, ROL::RangeSpaceOperator< Real >::b2_, ROL::RangeSpaceOperator< Real >::con_, ROL::RangeSpaceOperator< Real >::mul_, and ROL::RangeSpaceOperator< Real >::x_.

Referenced by ROL::ReduceLinearConstraint< Real >::feasible().

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

Apply adjoint of linear operator.

This function applies the adjoint of a linear operator to a vector. Default behavior assumes operator is self-adjoint.

Parameters
[out]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 55 of file ROL_RangeSpaceOperator.hpp.

template<class Real>
void ROL::RangeSpaceOperator< 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]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 59 of file ROL_RangeSpaceOperator.hpp.

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

Apply adjoint of the inverse linear operator.

This function applies the adjoint of the inverse linear operator to a vector. Default behavior assumes operator is self-adjoint.

Parameters
[out]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 63 of file ROL_RangeSpaceOperator.hpp.

Member Data Documentation

template<class Real>
const Ptr<Constraint<Real> > ROL::RangeSpaceOperator< Real >::con_
private

Definition at line 27 of file ROL_RangeSpaceOperator.hpp.

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

template<class Real>
const Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::x_
private
template<class Real>
Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::b1_
mutableprivate
template<class Real>
Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::b2_
mutableprivate
template<class Real>
Ptr<Vector<Real> > ROL::RangeSpaceOperator< Real >::mul_
mutableprivate

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