ROL
Public Member Functions | List of all members
ROL::ROL::LinearOperator< Real > Class Template Referenceabstract

#include <ROL_Constraint_SerialSimOpt.hpp>

Inheritance diagram for ROL::ROL::LinearOperator< Real >:

Public Member Functions

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.

Detailed Description

template<class Real>
class ROL::ROL::LinearOperator< Real >

Definition at line 37 of file ROL_Constraint_SerialSimOpt.hpp.

Constructor & Destructor Documentation

◆ ~LinearOperator()

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

Definition at line 40 of file ROL_Constraint_SerialSimOpt.hpp.

Member Function Documentation

◆ update()

template<class Real>
virtual void ROL::ROL::LinearOperator< 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 in ROL::ROL::NullSpaceOperator< Real >, and ROL::ROL::RangeSpaceOperator< Real >.

Definition at line 49 of file ROL_Constraint_SerialSimOpt.hpp.

◆ apply()

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

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.

Implemented in ROL::DyadicOperator< Real >, ROL::ROL::NullSpaceOperator< Real >, ROL::ROL::RangeSpaceOperator< Real >, and ROL::ROL::Secant< Real >.

◆ applyInverse()

template<class Real>
virtual void ROL::ROL::LinearOperator< 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 in ROL::DyadicOperator< Real >, ROL::ROL::NullSpaceOperator< Real >, ROL::ROL::RangeSpaceOperator< Real >, and ROL::ROL::Secant< Real >.

Definition at line 67 of file ROL_Constraint_SerialSimOpt.hpp.

◆ applyAdjoint()

template<class Real>
virtual void ROL::ROL::LinearOperator< 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 in ROL::ROL::NullSpaceOperator< Real >, and ROL::ROL::RangeSpaceOperator< Real >.

Definition at line 80 of file ROL_Constraint_SerialSimOpt.hpp.

◆ applyAdjointInverse()

template<class Real>
virtual void ROL::ROL::LinearOperator< 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 in ROL::ROL::NullSpaceOperator< Real >, and ROL::ROL::RangeSpaceOperator< Real >.

Definition at line 93 of file ROL_Constraint_SerialSimOpt.hpp.

References ui_.

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