ROL
Public Member Functions | Private Attributes | List of all members
ROL::NullSpaceOperator< Real > Class Template Reference
User Interface » Functional Interface

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

#include <ROL_NullSpaceOperator.hpp>

+ Inheritance diagram for ROL::NullSpaceOperator< Real >:

Public Member Functions

virtual ~NullSpaceOperator ()
 
 NullSpaceOperator (const Ptr< Constraint< Real > > &con, const Vector< Real > &dom, const Vector< Real > &ran, const bool useAugSys=false)
 
 NullSpaceOperator (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_
 
const bool useAugSys_
 
Ptr< Vector< Real > > b1_
 
Ptr< Vector< Real > > b1dual_
 
Ptr< Vector< Real > > b2_
 
Ptr< Vector< Real > > mul_
 
int dim_
 
Real b1sqr_
 

Detailed Description

template<class Real>
class ROL::NullSpaceOperator< Real >

Projects on to the null space of a linear constraint.

Definition at line 60 of file ROL_NullSpaceOperator.hpp.

Constructor & Destructor Documentation

◆ ~NullSpaceOperator()

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

Definition at line 75 of file ROL_NullSpaceOperator.hpp.

◆ NullSpaceOperator() [1/2]

template<class Real >
ROL::NullSpaceOperator< Real >::NullSpaceOperator ( const Ptr< Constraint< Real > > & con,
const Vector< Real > & dom,
const Vector< Real > & ran,
const bool useAugSys = false )
inline

Definition at line 76 of file ROL_NullSpaceOperator.hpp.

References ROL::NullSpaceOperator< Real >::b1_, ROL::NullSpaceOperator< Real >::b1dual_, ROL::NullSpaceOperator< Real >::b1sqr_, ROL::NullSpaceOperator< Real >::b2_, ROL::Vector< Real >::clone(), ROL::NullSpaceOperator< Real >::con_, ROL::NullSpaceOperator< Real >::dim_, ROL::Vector< Real >::dimension(), ROL::Vector< Real >::dual(), ROL::NullSpaceOperator< Real >::mul_, ROL::ROL_EPSILON(), ROL::NullSpaceOperator< Real >::useAugSys_, and ROL::NullSpaceOperator< Real >::x_.

◆ NullSpaceOperator() [2/2]

template<class Real >
ROL::NullSpaceOperator< Real >::NullSpaceOperator ( const Ptr< Constraint< Real > > & con,
const Ptr< const Vector< Real > > & dom,
const Ptr< const Vector< Real > > & ran )
inline

Definition at line 99 of file ROL_NullSpaceOperator.hpp.

Member Function Documentation

◆ update()

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

Definition at line 104 of file ROL_NullSpaceOperator.hpp.

References ROL::NullSpaceOperator< Real >::b1_, ROL::NullSpaceOperator< Real >::b1dual_, ROL::NullSpaceOperator< Real >::b1sqr_, ROL::NullSpaceOperator< Real >::b2_, ROL::NullSpaceOperator< Real >::con_, ROL::NullSpaceOperator< Real >::dim_, ROL::ROL_EPSILON(), ROL::NullSpaceOperator< Real >::useAugSys_, and ROL::NullSpaceOperator< Real >::x_.

◆ apply()

template<class Real >
virtual void ROL::NullSpaceOperator< Real >::apply ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inlinevirtual

Definition at line 114 of file ROL_NullSpaceOperator.hpp.

References ROL::Vector< Real >::axpy(), ROL::NullSpaceOperator< Real >::b1_, ROL::NullSpaceOperator< Real >::b1dual_, ROL::NullSpaceOperator< Real >::b1sqr_, ROL::NullSpaceOperator< Real >::b2_, ROL::NullSpaceOperator< Real >::con_, ROL::NullSpaceOperator< Real >::dim_, ROL::Vector< Real >::dot(), ROL::Vector< Real >::dual(), ROL::NullSpaceOperator< Real >::mul_, ROL::Vector< Real >::set(), ROL::NullSpaceOperator< Real >::useAugSys_, and ROL::NullSpaceOperator< Real >::x_.

Referenced by ROL::NullSpaceOperator< Real >::applyAdjoint(), and main().

◆ applyAdjoint()

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

Definition at line 126 of file ROL_NullSpaceOperator.hpp.

References ROL::NullSpaceOperator< Real >::apply().

◆ applyInverse()

template<class Real >
void ROL::NullSpaceOperator< Real >::applyInverse ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inline

Definition at line 130 of file ROL_NullSpaceOperator.hpp.

◆ applyAdjointInverse()

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

Definition at line 134 of file ROL_NullSpaceOperator.hpp.

Member Data Documentation

◆ con_

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

Definition at line 62 of file ROL_NullSpaceOperator.hpp.

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

◆ x_

template<class Real >
const Ptr<Vector<Real> > ROL::NullSpaceOperator< Real >::x_
private

Definition at line 63 of file ROL_NullSpaceOperator.hpp.

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

◆ useAugSys_

template<class Real >
const bool ROL::NullSpaceOperator< Real >::useAugSys_
private

Definition at line 64 of file ROL_NullSpaceOperator.hpp.

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

◆ b1_

template<class Real >
Ptr<Vector<Real> > ROL::NullSpaceOperator< Real >::b1_
mutableprivate

Definition at line 66 of file ROL_NullSpaceOperator.hpp.

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

◆ b1dual_

template<class Real >
Ptr<Vector<Real> > ROL::NullSpaceOperator< Real >::b1dual_
mutableprivate

Definition at line 67 of file ROL_NullSpaceOperator.hpp.

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

◆ b2_

template<class Real >
Ptr<Vector<Real> > ROL::NullSpaceOperator< Real >::b2_
mutableprivate

Definition at line 68 of file ROL_NullSpaceOperator.hpp.

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

◆ mul_

template<class Real >
Ptr<Vector<Real> > ROL::NullSpaceOperator< Real >::mul_
mutableprivate

Definition at line 69 of file ROL_NullSpaceOperator.hpp.

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

◆ dim_

template<class Real >
int ROL::NullSpaceOperator< Real >::dim_
private

Definition at line 71 of file ROL_NullSpaceOperator.hpp.

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

◆ b1sqr_

template<class Real >
Real ROL::NullSpaceOperator< Real >::b1sqr_
private

Definition at line 72 of file ROL_NullSpaceOperator.hpp.

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

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0