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)
 

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 91 of file ROL_Types.hpp.

Constructor & Destructor Documentation

◆ AlgorithmState()

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

Definition at line 108 of file ROL_Types.hpp.

Member Data Documentation

◆ iter

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

Definition at line 92 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(), 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::MoreauYosidaPenaltyStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

◆ minIter

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

Definition at line 93 of file ROL_Types.hpp.

Referenced by main().

◆ nfval

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

Definition at line 94 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::CompositeStep< 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::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

◆ ncval

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

Definition at line 95 of file ROL_Types.hpp.

Referenced by ROL::InteriorPointStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::AugmentedLagrangianStep< 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 96 of file ROL_Types.hpp.

Referenced by ROL::BundleStep< Real >::compute(), ROL::CompositeStep< 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::NewtonStep< Real >::print(), ROL::GradientStep< Real >::print(), ROL::NonlinearCGStep< Real >::print(), ROL::SecantStep< Real >::print(), ROL::ProjectedNewtonStep< Real >::print(), ROL::ProjectedSecantStep< Real >::print(), ROL::MoreauYosidaPenaltyStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

◆ value

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

Definition at line 97 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(), 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::MoreauYosidaPenaltyStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

◆ minValue

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

Definition at line 98 of file ROL_Types.hpp.

Referenced by main().

◆ gnorm

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

Definition at line 99 of file ROL_Types.hpp.

Referenced by ROL::StatusTest< Real >::check(), ROL::ConstraintStatusTest< Real >::check(), StatusTest_PDAS< Real >::check(), 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::AugmentedLagrangianStep< Real >::initialize(), ROL::BundleStep< Real >::initialize(), ROL::CompositeStep< 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::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

◆ cnorm

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

Definition at line 100 of file ROL_Types.hpp.

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

◆ snorm

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

Definition at line 101 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::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::MoreauYosidaPenaltyStep< Real >::print(), ROL::NewtonKrylovStep< Real >::print(), ROL::AugmentedLagrangianStep< Real >::print(), ROL::InteriorPointStep< Real >::print(), ROL::ProjectedNewtonKrylovStep< Real >::print(), ROL::CompositeStep< Real >::print(), ROL::BundleStep< Real >::print(), ROL::PrimalDualActiveSetStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), and ROL::TrustRegionStep< Real >::update().

◆ aggregateGradientNorm

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

Definition at line 102 of file ROL_Types.hpp.

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

◆ aggregateModelError

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

Definition at line 103 of file ROL_Types.hpp.

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

◆ flag

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

Definition at line 104 of file ROL_Types.hpp.

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

◆ iterateVec

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

Definition at line 105 of file ROL_Types.hpp.

Referenced by ROL::NewtonKrylovStep< Real >::compute(), ROL::ProjectedNewtonKrylovStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), main(), 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::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), and ROL::TrustRegionStep< Real >::update().

◆ lagmultVec

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

Definition at line 106 of file ROL_Types.hpp.

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

◆ minIterVec

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

Definition at line 107 of file ROL_Types.hpp.

Referenced by main().

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