ROL
Public Member Functions | Public Attributes | List of all members
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)
virtual ~AlgorithmState ()
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 109 of file ROL_Types.hpp.

Constructor & Destructor Documentation

◆ AlgorithmState()

template<class Real>
ROL::AlgorithmState< Real >::AlgorithmState ( void )
inline

Definition at line 128 of file ROL_Types.hpp.

References aggregateGradientNorm, aggregateModelError, cnorm, ROL::EXITSTATUS_LAST, flag, gnorm, iter, iterateVec, lagmultVec, minIter, minIterVec, minValue, nfval, ngrad, snorm, statusFlag, and value.

◆ ~AlgorithmState()

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

Definition at line 138 of file ROL_Types.hpp.

Member Function Documentation

◆ reset()

template<class Real>
void ROL::AlgorithmState< Real >::reset ( void )
inline

Definition at line 140 of file ROL_Types.hpp.

References aggregateGradientNorm, aggregateModelError, cnorm, flag, gnorm, iter, iterateVec, lagmultVec, minIter, minIterVec, minValue, ncval, nfval, ngrad, ROL::ROL_INF(), snorm, and value.

Member Data Documentation

◆ iter

template<class Real>
int ROL::AlgorithmState< Real >::iter

Definition at line 110 of file ROL_Types.hpp.

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

◆ minIter

template<class Real>
int ROL::AlgorithmState< Real >::minIter

Definition at line 111 of file ROL_Types.hpp.

Referenced by AlgorithmState(), main(), and reset().

◆ nfval

template<class Real>
int ROL::AlgorithmState< Real >::nfval

Definition at line 112 of file ROL_Types.hpp.

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

◆ ncval

template<class Real>
int ROL::AlgorithmState< Real >::ncval

Definition at line 113 of file ROL_Types.hpp.

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

◆ ngrad

template<class Real>
int ROL::AlgorithmState< Real >::ngrad

Definition at line 114 of file ROL_Types.hpp.

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

◆ value

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

Definition at line 115 of file ROL_Types.hpp.

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

◆ minValue

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

Definition at line 116 of file ROL_Types.hpp.

Referenced by AlgorithmState(), main(), and reset().

◆ gnorm

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

Definition at line 117 of file ROL_Types.hpp.

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

◆ cnorm

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

Definition at line 118 of file ROL_Types.hpp.

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

◆ snorm

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

Definition at line 119 of file ROL_Types.hpp.

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

◆ aggregateGradientNorm

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

Definition at line 120 of file ROL_Types.hpp.

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

◆ aggregateModelError

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

Definition at line 121 of file ROL_Types.hpp.

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

◆ flag

template<class Real>
bool ROL::AlgorithmState< Real >::flag

Definition at line 122 of file ROL_Types.hpp.

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

◆ iterateVec

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

Definition at line 123 of file ROL_Types.hpp.

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

◆ lagmultVec

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

Definition at line 124 of file ROL_Types.hpp.

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

◆ minIterVec

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

Definition at line 125 of file ROL_Types.hpp.

Referenced by AlgorithmState(), main(), and reset().

◆ statusFlag

template<class Real>
EExitStatus ROL::AlgorithmState< Real >::statusFlag

Definition at line 126 of file ROL_Types.hpp.

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

The documentation for this struct was generated from the following file:
Generated by doxygen 1.15.0