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)
void	reset (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
ROL::Ptr< Vector< Real > >	iterateVec
ROL::Ptr< Vector< Real > >	lagmultVec
ROL::Ptr< Vector< Real > >	minIterVec
EExitStatus	statusFlag

Detailed Description

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

State for algorithm class. Will be used for restarts.

Definition at line 143 of file ROL_Types.hpp.

Constructor & Destructor Documentation

template<class Real>

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

inline

Definition at line 162 of file ROL_Types.hpp.

Member Function Documentation

template<class Real>

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

inline

Definition at line 172 of file ROL_Types.hpp.

References ROL::AlgorithmState< Real >::aggregateGradientNorm, ROL::AlgorithmState< Real >::aggregateModelError, ROL::AlgorithmState< Real >::cnorm, ROL::AlgorithmState< Real >::flag, ROL::AlgorithmState< Real >::gnorm, ROL::AlgorithmState< Real >::iter, ROL::AlgorithmState< Real >::iterateVec, ROL::AlgorithmState< Real >::lagmultVec, ROL::AlgorithmState< Real >::minIter, ROL::AlgorithmState< Real >::minIterVec, ROL::AlgorithmState< Real >::minValue, ROL::AlgorithmState< Real >::ncval, ROL::AlgorithmState< Real >::nfval, ROL::AlgorithmState< Real >::ngrad, ROL::AlgorithmState< Real >::snorm, and ROL::AlgorithmState< Real >::value.

Member Data Documentation

template<class Real>

int ROL::AlgorithmState< Real >::iter

Definition at line 144 of file ROL_Types.hpp.

Referenced by ROL::CompositeStep< Real >::accept(), ROL::BundleStatusTest< Real >::check(), ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), ROL::FletcherStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), ROL::BundleStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), main(), ROL::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::PrimalDualRisk< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::FletcherStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

int ROL::AlgorithmState< Real >::minIter

Definition at line 145 of file ROL_Types.hpp.

Referenced by main(), and ROL::AlgorithmState< Real >::reset().

template<class Real>

int ROL::AlgorithmState< Real >::nfval

Definition at line 146 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::CompositeStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::FletcherStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

int ROL::AlgorithmState< Real >::ncval

Definition at line 147 of file ROL_Types.hpp.

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

template<class Real>

int ROL::AlgorithmState< Real >::ngrad

Definition at line 148 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::CompositeStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::FletcherStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::value

Definition at line 149 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::FletcherStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), main(), ROL::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::PrimalDualRisk< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::FletcherStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::minValue

Definition at line 150 of file ROL_Types.hpp.

Referenced by main(), and ROL::AlgorithmState< Real >::reset().

template<class Real>

Real ROL::AlgorithmState< Real >::gnorm

Definition at line 151 of file ROL_Types.hpp.

Referenced by ROL::PH_StatusTest< Real >::check(), ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), ROL::FletcherStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), ROL::PrimalDualRisk< Real >::checkStatus(), ROL::ProjectedNewtonStep< Real >::compute(), ROL::ProjectedSecantStep< Real >::compute(), ROL::ProjectedNewtonKrylovStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), ROL::TrustRegionStep< Real >::compute(), ROL::Step< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::FletcherStep< Real >::initialize(), ROL::BundleStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::PrimalDualRisk< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::FletcherStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::cnorm

Definition at line 152 of file ROL_Types.hpp.

Referenced by ROL::ConstraintStatusTest< Real >::check(), ROL::FletcherStatusTest< Real >::check(), ROL::PrimalDualRisk< Real >::checkStatus(), ROL::InteriorPointStep< Real >::initialize(), ROL::FletcherStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualRisk< Real >::print(), ROL::FletcherStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::FletcherStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

template<class Real>

Real ROL::AlgorithmState< Real >::snorm

Definition at line 153 of file ROL_Types.hpp.

Referenced by ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), ROL::FletcherStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), ROL::BundleStep< Real >::compute(), ROL::TrustRegionStep< Real >::compute(), ROL::TrustRegionStep< Real >::initialize(), ROL::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), and ROL::TrustRegionStep< Real >::update().

template<class Real>

Real ROL::AlgorithmState< Real >::aggregateGradientNorm

Definition at line 154 of file ROL_Types.hpp.

Referenced by ROL::BundleStatusTest< Real >::check(), ROL::FletcherStatusTest< Real >::check(), ROL::BundleStep< Real >::compute(), ROL::FletcherStep< Real >::initialize(), ROL::BundleStep< Real >::print(), ROL::AlgorithmState< Real >::reset(), and ROL::FletcherStep< Real >::update().

template<class Real>

Real ROL::AlgorithmState< Real >::aggregateModelError

Definition at line 155 of file ROL_Types.hpp.

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

template<class Real>

bool ROL::AlgorithmState< Real >::flag

Definition at line 156 of file ROL_Types.hpp.

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

template<class Real>

ROL::Ptr<Vector<Real> > ROL::AlgorithmState< Real >::iterateVec

Definition at line 157 of file ROL_Types.hpp.

Referenced by ROL::PH_StatusTest< Real >::check(), ROL::NewtonKrylovStep< Real >::compute(), ROL::ProjectedNewtonKrylovStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), main(), ROL::AlgorithmState< Real >::reset(), ROL::NewtonStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), and ROL::TrustRegionStep< Real >::update().

template<class Real>

ROL::Ptr<Vector<Real> > ROL::AlgorithmState< Real >::lagmultVec

Definition at line 158 of file ROL_Types.hpp.

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

template<class Real>

ROL::Ptr<Vector<Real> > ROL::AlgorithmState< Real >::minIterVec

Definition at line 159 of file ROL_Types.hpp.

Referenced by main(), and ROL::AlgorithmState< Real >::reset().

template<class Real>

EExitStatus ROL::AlgorithmState< Real >::statusFlag

Definition at line 160 of file ROL_Types.hpp.

Referenced by ROL::BundleStatusTest< Real >::check(), ROL::PH_StatusTest< Real >::check(), ROL::StatusTest< Real >::check(), ROL::FletcherStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::check().

---

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

• ROL_Types.hpp