Provides the std::vector implementation to apply a linear operator, which is a std::vector representation of column-stacked matrix. More...

#include <ROL_StdLinearOperator.hpp>

Inheritance diagram for ROL::StdLinearOperator< Real >:

Public Member Functions
	StdLinearOperator ()

	StdLinearOperator (RCP< std::vector< Real > > &A)

virtual	~StdLinearOperator ()

void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update linear operator. More...

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

void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply linear operator. More...

virtual void	apply (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const

void	applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply adjoint of linear operator. More...

virtual void	applyAdjoint (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const

void	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply inverse of linear operator. More...

virtual void	applyInverse (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const

void	applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply adjoint of the inverse linear operator. More...

virtual void	applyAdjointInverse (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const

Public Member Functions inherited from ROL::LinearOperator< Real >
virtual	~LinearOperator ()

Private Types
template<typename T >
using	RCP = Teuchos::RCP< T >

typedef StdVector< Real >	SV

typedef std::vector< Real >	vector

Private Attributes
RCP< std::vector< Real > >	A_

int	N_

int	INFO_

vector	PLU_

std::vector< int >	ipiv_

Teuchos::BLAS< int, Real >	blas_

Teuchos::LAPACK< int, Real >	lapack_

Detailed Description

template<class Real>
class ROL::StdLinearOperator< Real >

Provides the std::vector implementation to apply a linear operator, which is a std::vector representation of column-stacked matrix.

Currently, this interface requires that the underlying matrix be square

Definition at line 66 of file ROL_StdLinearOperator.hpp.

Member Typedef Documentation

◆ RCP

template<class Real >

template<typename T >

using ROL::StdLinearOperator< Real >::RCP = Teuchos::RCP<T>

private

Definition at line 68 of file ROL_StdLinearOperator.hpp.

◆ SV

template<class Real >

typedef StdVector<Real> ROL::StdLinearOperator< Real >::SV

private

Definition at line 70 of file ROL_StdLinearOperator.hpp.

◆ vector

template<class Real >

typedef std::vector<Real> ROL::StdLinearOperator< Real >::vector

private

Definition at line 72 of file ROL_StdLinearOperator.hpp.

Constructor & Destructor Documentation

◆ StdLinearOperator() [1/2]

template<class Real >

ROL::StdLinearOperator< Real >::StdLinearOperator ( )

inline

Definition at line 88 of file ROL_StdLinearOperator.hpp.

◆ StdLinearOperator() [2/2]

template<class Real >

ROL::StdLinearOperator< Real >::StdLinearOperator ( RCP< std::vector< Real > > & A )

inline

Definition at line 90 of file ROL_StdLinearOperator.hpp.

◆ ~StdLinearOperator()

template<class Real >

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

inlinevirtual

Definition at line 100 of file ROL_StdLinearOperator.hpp.

Member Function Documentation

◆ update() [1/2]

template<class Real >

void ROL::StdLinearOperator< 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::LinearOperator< Real >.

Definition at line 103 of file ROL_StdLinearOperator.hpp.

◆ update() [2/2]

template<class Real >

virtual void ROL::StdLinearOperator< Real >::update	(	const std::vector< Real > &	x,
		bool	flag = `true`,
		int	iter = `-1`
	)

inlinevirtual

Definition at line 108 of file ROL_StdLinearOperator.hpp.

◆ apply() [1/2]

template<class Real >

void ROL::StdLinearOperator< 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::LinearOperator< Real >.

Definition at line 112 of file ROL_StdLinearOperator.hpp.

◆ apply() [2/2]

template<class Real >

virtual void ROL::StdLinearOperator< Real >::apply	(	std::vector< Real > &	Hv,
		const std::vector< Real > &	v,
		Real &	tol
	)		const

inlinevirtual

Definition at line 119 of file ROL_StdLinearOperator.hpp.

References ROL::StdLinearOperator< Real >::N_.

◆ applyAdjoint() [1/2]

template<class Real >

void ROL::StdLinearOperator< 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::LinearOperator< Real >.

Definition at line 127 of file ROL_StdLinearOperator.hpp.

◆ applyAdjoint() [2/2]

template<class Real >

virtual void ROL::StdLinearOperator< Real >::applyAdjoint	(	std::vector< Real > &	Hv,
		const std::vector< Real > &	v,
		Real &	tol
	)		const

inlinevirtual

Definition at line 134 of file ROL_StdLinearOperator.hpp.

References ROL::StdLinearOperator< Real >::N_.

◆ applyInverse() [1/2]

template<class Real >

void ROL::StdLinearOperator< 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::LinearOperator< Real >.

Definition at line 144 of file ROL_StdLinearOperator.hpp.

◆ applyInverse() [2/2]

template<class Real >

virtual void ROL::StdLinearOperator< Real >::applyInverse	(	std::vector< Real > &	Hv,
		const std::vector< Real > &	v,
		Real &	tol
	)		const

inlinevirtual

Definition at line 151 of file ROL_StdLinearOperator.hpp.

References ROL::StdLinearOperator< Real >::A_, and ROL::StdLinearOperator< Real >::N_.

◆ applyAdjointInverse() [1/2]

template<class Real >

void ROL::StdLinearOperator< 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::LinearOperator< Real >.

Definition at line 181 of file ROL_StdLinearOperator.hpp.

◆ applyAdjointInverse() [2/2]

template<class Real >

virtual void ROL::StdLinearOperator< Real >::applyAdjointInverse	(	std::vector< Real > &	Hv,
		const std::vector< Real > &	v,
		Real &	tol
	)		const

inlinevirtual

Definition at line 188 of file ROL_StdLinearOperator.hpp.

References ROL::StdLinearOperator< Real >::A_, and ROL::StdLinearOperator< Real >::N_.

Member Data Documentation

◆ A_

template<class Real >

RCP<std::vector<Real> > ROL::StdLinearOperator< Real >::A_

private

Definition at line 76 of file ROL_StdLinearOperator.hpp.

Referenced by ROL::StdLinearOperator< Real >::applyAdjointInverse(), and ROL::StdLinearOperator< Real >::applyInverse().

◆ N_

template<class Real >

int ROL::StdLinearOperator< Real >::N_

private

Definition at line 77 of file ROL_StdLinearOperator.hpp.

Referenced by ROL::StdLinearOperator< Real >::apply(), ROL::StdLinearOperator< Real >::applyAdjoint(), ROL::StdLinearOperator< Real >::applyAdjointInverse(), and ROL::StdLinearOperator< Real >::applyInverse().

◆ INFO_

template<class Real >

int ROL::StdLinearOperator< Real >::INFO_

private

Definition at line 78 of file ROL_StdLinearOperator.hpp.

◆ PLU_

template<class Real >

vector ROL::StdLinearOperator< Real >::PLU_

mutableprivate

Definition at line 80 of file ROL_StdLinearOperator.hpp.

◆ ipiv_

template<class Real >

std::vector<int> ROL::StdLinearOperator< Real >::ipiv_

mutableprivate

Definition at line 81 of file ROL_StdLinearOperator.hpp.

◆ blas_

template<class Real >

Teuchos::BLAS<int,Real> ROL::StdLinearOperator< Real >::blas_

private

Definition at line 83 of file ROL_StdLinearOperator.hpp.

◆ lapack_

template<class Real >

Teuchos::LAPACK<int,Real> ROL::StdLinearOperator< Real >::lapack_

private

Definition at line 84 of file ROL_StdLinearOperator.hpp.

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

ROL_StdLinearOperator.hpp

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<class Real> class ROL::StdLinearOperator< Real >

Currently, this interface requires that the underlying matrix be square

Member Typedef Documentation

◆ RCP

◆ SV

◆ vector

Constructor & Destructor Documentation

◆ StdLinearOperator() [1/2]

◆ StdLinearOperator() [2/2]

◆ ~StdLinearOperator()

Member Function Documentation

◆ update() [1/2]

◆ update() [2/2]

◆ apply() [1/2]

◆ apply() [2/2]

◆ applyAdjoint() [1/2]

◆ applyAdjoint() [2/2]

◆ applyInverse() [1/2]

◆ applyInverse() [2/2]

◆ applyAdjointInverse() [1/2]

◆ applyAdjointInverse() [2/2]

Member Data Documentation

◆ A_

◆ N_

◆ INFO_

◆ PLU_

◆ ipiv_

◆ blas_

◆ lapack_

template<class Real>
class ROL::StdLinearOperator< Real >