ROL: ROL::ROL::NullSpaceOperator< Real > Class Template Reference

ROL

#include <ROL_Constraint_SerialSimOpt.hpp>

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

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::ROL::NullSpaceOperator< Real >

Definition at line 26 of file ROL_Constraint_SerialSimOpt.hpp.

Constructor & Destructor Documentation

◆ ~NullSpaceOperator()

template<class Real>

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

inlinevirtual

Definition at line 41 of file ROL_Constraint_SerialSimOpt.hpp.

◆ NullSpaceOperator() [1/2]

template<class Real>

ROL::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 42 of file ROL_Constraint_SerialSimOpt.hpp.

◆ NullSpaceOperator() [2/2]

template<class Real>

ROL::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 65 of file ROL_Constraint_SerialSimOpt.hpp.

Member Function Documentation

◆ update()

template<class Real>

virtual void ROL::ROL::NullSpaceOperator< 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]	x	is the new iterate.
[in]	flag	is true if the iterate has changed.
[in]	iter	is the outer algorithm iterations count.

Reimplemented from ROL::ROL::LinearOperator< Real >.

Definition at line 70 of file ROL_Constraint_SerialSimOpt.hpp.

◆ apply()

template<class Real>

virtual void ROL::ROL::NullSpaceOperator< 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]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Implements ROL::ROL::LinearOperator< Real >.

Definition at line 80 of file ROL_Constraint_SerialSimOpt.hpp.

◆ applyAdjoint()

template<class Real>

void ROL::ROL::NullSpaceOperator< 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]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Reimplemented from ROL::ROL::LinearOperator< Real >.

Definition at line 92 of file ROL_Constraint_SerialSimOpt.hpp.

◆ applyInverse()

template<class Real>

void ROL::ROL::NullSpaceOperator< 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]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Reimplemented from ROL::ROL::LinearOperator< Real >.

Definition at line 96 of file ROL_Constraint_SerialSimOpt.hpp.

References con_.

◆ applyAdjointInverse()

template<class Real>

void ROL::ROL::NullSpaceOperator< 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]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Reimplemented from ROL::ROL::LinearOperator< Real >.

Definition at line 100 of file ROL_Constraint_SerialSimOpt.hpp.

Member Data Documentation

◆ con_

template<class Real>

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

private

Definition at line 28 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by applyInverse().

◆ x_

template<class Real>

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

private

Definition at line 29 of file ROL_Constraint_SerialSimOpt.hpp.

◆ useAugSys_

template<class Real>

const bool ROL::ROL::NullSpaceOperator< Real >::useAugSys_

private

Definition at line 30 of file ROL_Constraint_SerialSimOpt.hpp.

◆ b1_

template<class Real>

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

mutableprivate

Definition at line 32 of file ROL_Constraint_SerialSimOpt.hpp.

◆ b1dual_

template<class Real>

Ptr<Vector<Real> > ROL::ROL::NullSpaceOperator< Real >::b1dual_

mutableprivate

Definition at line 33 of file ROL_Constraint_SerialSimOpt.hpp.

◆ b2_

template<class Real>

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

mutableprivate

Definition at line 34 of file ROL_Constraint_SerialSimOpt.hpp.

◆ mul_

template<class Real>

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

mutableprivate

Definition at line 35 of file ROL_Constraint_SerialSimOpt.hpp.

◆ dim_

template<class Real>

int ROL::ROL::NullSpaceOperator< Real >::dim_

private

Definition at line 37 of file ROL_Constraint_SerialSimOpt.hpp.

◆ b1sqr_

template<class Real>

Real ROL::ROL::NullSpaceOperator< Real >::b1sqr_

private

Definition at line 38 of file ROL_Constraint_SerialSimOpt.hpp.

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

ROL_Constraint_SerialSimOpt.hpp