ROL
Public Member Functions | Private Attributes | List of all members
ROL::NonlinearCG< Real > Class Template Reference

Implementats nonlinear conjugate gradient methods. More...

#include <ROL_NonlinearCG.hpp>

Public Member Functions

virtual ~NonlinearCG ()
 
 NonlinearCG (ENonlinearCG type, int restart=100)
 
Teuchos::RCP< NonlinearCGState
< Real > > & 
get_state ()
 
virtual void run (Vector< Real > &s, const Vector< Real > &g, const Vector< Real > &x, Objective< Real > &obj)
 

Private Attributes

Teuchos::RCP< NonlinearCGState
< Real > > 
state_
 
Teuchos::RCP< Vector< Real > > y_
 
Teuchos::RCP< Vector< Real > > yd_
 

Detailed Description

template<class Real>
class ROL::NonlinearCG< Real >

Implementats nonlinear conjugate gradient methods.

Definition at line 65 of file ROL_NonlinearCG.hpp.

Constructor & Destructor Documentation

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

Definition at line 75 of file ROL_NonlinearCG.hpp.

template<class Real >
ROL::NonlinearCG< Real >::NonlinearCG ( ENonlinearCG< Real >  type,
int  restart = 100 
)
inline

Member Function Documentation

template<class Real >
Teuchos::RCP<NonlinearCGState<Real> >& ROL::NonlinearCG< Real >::get_state ( )
inline

Definition at line 93 of file ROL_NonlinearCG.hpp.

References ROL::NonlinearCG< Real >::state_.

template<class Real >
virtual void ROL::NonlinearCG< Real >::run ( Vector< Real > &  s,
const Vector< Real > &  g,
const Vector< Real > &  x,
Objective< Real > &  obj 
)
inlinevirtual

Member Data Documentation

template<class Real >
Teuchos::RCP<NonlinearCGState<Real> > ROL::NonlinearCG< Real >::state_
private
template<class Real >
Teuchos::RCP<Vector<Real> > ROL::NonlinearCG< Real >::y_
private

Definition at line 70 of file ROL_NonlinearCG.hpp.

Referenced by ROL::NonlinearCG< Real >::run().

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::NonlinearCG< Real >::yd_
private

Definition at line 71 of file ROL_NonlinearCG.hpp.

Referenced by ROL::NonlinearCG< Real >::run().


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