ROL
ROL::TruncatedCG_U< Real > Class Template Reference

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::ROL::TrustRegion_U< Real >
virtual ~TrustRegion_U ()
virtual void initialize (const Vector< Real > &x, const Vector< Real > &g)
virtual void solve (Vector< Real > &s, Real &snorm, Real &pRed, int &iflag, int &iter, const Real del, TrustRegionModel_U< Real > &model)=0

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

◆ TruncatedCG_U()

template<class Real>
ROL::TruncatedCG_U< Real >::TruncatedCG_U ( ParameterList & parlist)
inline

Definition at line 34 of file ROL_TruncatedCG_U.hpp.

References maxit_, tol1_, and tol2_.

Member Function Documentation

◆ initialize()

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

Definition at line 42 of file ROL_TruncatedCG_U.hpp.

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

◆ solve()

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 )
inline

Member Data Documentation

◆ s_

template<class Real>
Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::s_
private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by initialize(), and solve().

◆ g_

template<class Real>
Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::g_
private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by initialize(), and solve().

◆ v_

template<class Real>
Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::v_
private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by initialize(), and solve().

◆ p_

template<class Real>
Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::p_
private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by initialize(), and solve().

◆ Hp_

template<class Real>
Ptr<Vector<Real> > ROL::TruncatedCG_U< Real >::Hp_
private

Definition at line 25 of file ROL_TruncatedCG_U.hpp.

Referenced by initialize(), and solve().

◆ maxit_

template<class Real>
int ROL::TruncatedCG_U< Real >::maxit_
private

Definition at line 27 of file ROL_TruncatedCG_U.hpp.

Referenced by solve(), and TruncatedCG_U().

◆ tol1_

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

Definition at line 28 of file ROL_TruncatedCG_U.hpp.

Referenced by solve(), and TruncatedCG_U().

◆ tol2_

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

Definition at line 29 of file ROL_TruncatedCG_U.hpp.

Referenced by solve(), and TruncatedCG_U().


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