ROL::StepState< Real > Struct Template Reference

State for step class. Will be used for restarts. More...

#include <ROL_Types.hpp>

Public Member Functions
	StepState (void)
void	reset (const Real searchSizeInput=1.0)

Public Attributes
ROL::Ptr< Vector< Real > >	gradientVec
ROL::Ptr< Vector< Real > >	descentVec
ROL::Ptr< Vector< Real > >	constraintVec
int	nfval
int	ngrad
Real	searchSize
int	flag
int	SPiter
int	SPflag

Detailed Description

template<class Real>
struct ROL::StepState< Real >

State for step class. Will be used for restarts.

Definition at line 203 of file ROL_Types.hpp.

Constructor & Destructor Documentation

StepState()

template<class Real>

ROL::StepState< Real >::StepState ( void )

inline

Definition at line 214 of file ROL_Types.hpp.

References constraintVec, descentVec, flag, gradientVec, nfval, ngrad, searchSize, SPflag, and SPiter.

Member Function Documentation

reset()

template<class Real>

void ROL::StepState< Real >::reset ( const Real searchSizeInput = 1.0 )

inline

Definition at line 224 of file ROL_Types.hpp.

References constraintVec, descentVec, flag, gradientVec, nfval, ngrad, searchSize, SPflag, and SPiter.

Member Data Documentation

gradientVec

template<class Real>

ROL::Ptr<Vector<Real> > ROL::StepState< Real >::gradientVec

Definition at line 204 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

descentVec

template<class Real>

ROL::Ptr<Vector<Real> > ROL::StepState< Real >::descentVec

Definition at line 205 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

constraintVec

template<class Real>

ROL::Ptr<Vector<Real> > ROL::StepState< Real >::constraintVec

Definition at line 206 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

nfval

template<class Real>

int ROL::StepState< Real >::nfval

Definition at line 207 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

ngrad

template<class Real>

int ROL::StepState< Real >::ngrad

Definition at line 208 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

searchSize

template<class Real>

Real ROL::StepState< Real >::searchSize

Definition at line 209 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

flag

template<class Real>

int ROL::StepState< Real >::flag

Definition at line 210 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

SPiter

template<class Real>

int ROL::StepState< Real >::SPiter

Definition at line 211 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

SPflag

template<class Real>

int ROL::StepState< Real >::SPflag

Definition at line 212 of file ROL_Types.hpp.

Referenced by reset(), and StepState().

---

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

• ROL_Types.hpp