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

ROL

Provides interface for truncated CG trust-region subproblem solver. More...

#include <ROL_TruncatedCG_U.hpp>

Inheritance diagram for ROL::TruncatedCG_U< Real >:

Public Member Functions
	TruncatedCG_U (ParameterList &parlist)

void	initialize (const Vector< Real > &x, const Vector< Real > &g)

void	solve (Vector< Real > &s, Real &snorm, Real &pRed, int &iflag, int &iter, const Real del, TrustRegionModel_U< Real > &model)

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

Private Attributes
Ptr< Vector< Real > >	s_

Ptr< Vector< Real > >	g_

Ptr< Vector< Real > >	v_

Ptr< Vector< Real > >	p_

Ptr< Vector< Real > >	Hp_

int	maxit_

Real	tol1_

Real	tol2_

Detailed Description

template<class Real>
class ROL::TruncatedCG_U< Real >

Provides interface for truncated CG trust-region subproblem solver.

Definition at line 23 of file ROL_TruncatedCG_U.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::TruncatedCG_U< Real >::TruncatedCG_U ( ParameterList & parlist )

inline

Definition at line 34 of file ROL_TruncatedCG_U.hpp.

References ROL::TruncatedCG_U< Real >::maxit_, ROL::TruncatedCG_U< Real >::tol1_, and ROL::TruncatedCG_U< Real >::tol2_.

Member Function Documentation

template<class Real >

void ROL::TruncatedCG_U< Real >::initialize	(	const Vector< Real > &	x,
		const Vector< Real > &	g
	)

inlinevirtual

Reimplemented from ROL::TrustRegion_U< Real >.

Definition at line 42 of file ROL_TruncatedCG_U.hpp.

References ROL::Vector< Real >::clone(), ROL::TruncatedCG_U< Real >::g_, ROL::TruncatedCG_U< Real >::Hp_, ROL::TruncatedCG_U< Real >::p_, ROL::TruncatedCG_U< Real >::s_, and ROL::TruncatedCG_U< Real >::v_.

template<class Real >

void ROL::TruncatedCG_U< Real >::solve	(	Vector< Real > &	s,
		Real &	snorm,
		Real &	pRed,
		int &	iflag,
		int &	iter,
		const Real	del,
		TrustRegionModel_U< Real > &	model
	)

inlinevirtual

Implements ROL::TrustRegion_U< Real >.

Definition at line 50 of file ROL_TruncatedCG_U.hpp.

References ROL::Vector< Real >::axpy(), ROL::TruncatedCG_U< Real >::g_, ROL::TrustRegionModel_U< Real >::getGradient(), ROL::TrustRegionModel_U< Real >::hessVec(), ROL::TruncatedCG_U< Real >::Hp_, ROL::TruncatedCG_U< Real >::maxit_, ROL::TruncatedCG_U< Real >::p_, ROL::TrustRegionModel_U< Real >::precond(), ROL::TruncatedCG_U< Real >::s_, ROL::Vector< Real >::set(), ROL::TruncatedCG_U< Real >::tol1_, ROL::TruncatedCG_U< Real >::tol2_, ROL::TruncatedCG_U< Real >::v_, zero, and ROL::Vector< Real >::zero().

Member Data Documentation

template<class Real >

Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::s_

private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::initialize(), and ROL::TruncatedCG_U< Real >::solve().

template<class Real >

Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::g_

private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::initialize(), and ROL::TruncatedCG_U< Real >::solve().

template<class Real >

Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::v_

private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::initialize(), and ROL::TruncatedCG_U< Real >::solve().

template<class Real >

Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::p_

private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::initialize(), and ROL::TruncatedCG_U< Real >::solve().

template<class Real >

Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::Hp_

private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::initialize(), and ROL::TruncatedCG_U< Real >::solve().

template<class Real >

int ROL::TruncatedCG_U< Real >::maxit_

private

Definition at line 27 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::solve(), and ROL::TruncatedCG_U< Real >::TruncatedCG_U().

template<class Real >

Real ROL::TruncatedCG_U< Real >::tol1_

private

Definition at line 28 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::solve(), and ROL::TruncatedCG_U< Real >::TruncatedCG_U().

template<class Real >

Real ROL::TruncatedCG_U< Real >::tol2_

private

Definition at line 29 of file ROL_TruncatedCG_U.hpp.

Referenced by ROL::TruncatedCG_U< Real >::solve(), and ROL::TruncatedCG_U< Real >::TruncatedCG_U().

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

ROL_TruncatedCG_U.hpp