ROL::AlgorithmState< Real > Struct Template Reference

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

#include <ROL_Types.hpp>

Public Member Functions
	AlgorithmState (void)

Public Attributes
int	iter
int	minIter
int	nfval
int	ncval
int	ngrad
Real	value
Real	minValue
Real	gnorm
Real	cnorm
Real	snorm
Real	aggregateGradientNorm
Real	aggregateModelError
bool	flag
Teuchos::RCP< Vector< Real > >	iterateVec
Teuchos::RCP< Vector< Real > >	lagmultVec
Teuchos::RCP< Vector< Real > >	minIterVec

Detailed Description

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

State for algorithm class. Will be used for restarts.

Definition at line 77 of file ROL_Types.hpp.

Constructor & Destructor Documentation

template<class Real>

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

inline

Definition at line 94 of file ROL_Types.hpp.

Member Data Documentation

template<class Real>

int ROL::AlgorithmState< Real >::iter

Definition at line 78 of file ROL_Types.hpp.

Referenced by ROL::CompositeStep< Real >::accept(), ROL::BundleStatusTest< Real >::check(), ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), ROL::BundleStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::InteriorPointStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::LineSearchStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

int ROL::AlgorithmState< Real >::minIter

Definition at line 79 of file ROL_Types.hpp.

template<class Real>

int ROL::AlgorithmState< Real >::nfval

Definition at line 80 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::CompositeStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::LineSearchStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

int ROL::AlgorithmState< Real >::ncval

Definition at line 81 of file ROL_Types.hpp.

Referenced by ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

int ROL::AlgorithmState< Real >::ngrad

Definition at line 82 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::CompositeStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::value

Definition at line 83 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::LineSearchStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::minValue

Definition at line 84 of file ROL_Types.hpp.

template<class Real>

Real ROL::AlgorithmState< Real >::gnorm

Definition at line 85 of file ROL_Types.hpp.

Referenced by ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), ROL::PrimalDualActiveSetStep< Real >::compute(), ROL::TrustRegionStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::BundleStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::cnorm

Definition at line 86 of file ROL_Types.hpp.

Referenced by ROL::ConstraintStatusTest< Real >::check(), ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::CompositeStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::snorm

Definition at line 87 of file ROL_Types.hpp.

Referenced by ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), ROL::BundleStep< Real >::compute(), ROL::TrustRegionStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::TrustRegionStep< Real >::initialize(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::LineSearchStep< Real >::update().

template<class Real>

Real ROL::AlgorithmState< Real >::aggregateGradientNorm

Definition at line 88 of file ROL_Types.hpp.

Referenced by ROL::BundleStatusTest< Real >::check(), ROL::BundleStep< Real >::compute(), and ROL::BundleStep< Real >::print().

template<class Real>

Real ROL::AlgorithmState< Real >::aggregateModelError

Definition at line 89 of file ROL_Types.hpp.

Referenced by ROL::BundleStatusTest< Real >::check(), ROL::BundleStep< Real >::compute(), and ROL::BundleStep< Real >::print().

template<class Real>

bool ROL::AlgorithmState< Real >::flag

Definition at line 90 of file ROL_Types.hpp.

Referenced by ROL::BundleStatusTest< Real >::check(), ROL::BundleStep< Real >::compute(), and ROL::BundleStep< Real >::update().

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::AlgorithmState< Real >::iterateVec

Definition at line 91 of file ROL_Types.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::LineSearchStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::LineSearchStep< Real >::update().

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::AlgorithmState< Real >::lagmultVec

Definition at line 92 of file ROL_Types.hpp.

Referenced by ROL::AugmentedLagrangianStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::update().

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::AlgorithmState< Real >::minIterVec

Definition at line 93 of file ROL_Types.hpp.

---

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

• ROL_Types.hpp