Provides an interface to check status of optimization algorithms for problems with equality constraints. More...
#include <ROL_ConstraintStatusTest.hpp>
Inheritance diagram for ROL::ConstraintStatusTest< Real >:
Public Member Functions | |
| virtual | ~ConstraintStatusTest () |
| ConstraintStatusTest (ROL::ParameterList &parlist) | |
| ConstraintStatusTest (Real gtol=1e-6, Real ctol=1e-6, Real stol=1e-12, int max_iter=100, bool use_rel=false) | |
| virtual bool | check (AlgorithmState< Real > &state) |
| Check algorithm status. More... | |
| Public Member Functions inherited from ROL::StatusTest< Real > | |
| virtual | ~StatusTest () |
| StatusTest (ParameterList &parlist) | |
| StatusTest (Real gtol=1.e-6, Real stol=1.e-12, int max_iter=100, bool use_rel=false) | |
Private Attributes | |
| Real | gtol_ |
| Real | gtol0_ |
| Real | ctol_ |
| Real | ctol0_ |
| Real | stol_ |
| Real | stol0_ |
| int | max_iter_ |
| bool | use_rel_ |
Detailed Description
template<class Real>
class ROL::ConstraintStatusTest< Real >
Provides an interface to check status of optimization algorithms for problems with equality constraints.
Definition at line 24 of file ROL_ConstraintStatusTest.hpp.
Constructor & Destructor Documentation
|
inlinevirtual |
Definition at line 35 of file ROL_ConstraintStatusTest.hpp.
|
inline |
Definition at line 37 of file ROL_ConstraintStatusTest.hpp.
References ROL::ConstraintStatusTest< Real >::ctol0_, ROL::ConstraintStatusTest< Real >::ctol_, ROL::ConstraintStatusTest< Real >::gtol0_, ROL::ConstraintStatusTest< Real >::gtol_, ROL::ConstraintStatusTest< Real >::max_iter_, ROL::ConstraintStatusTest< Real >::stol0_, ROL::ConstraintStatusTest< Real >::stol_, and ROL::ConstraintStatusTest< Real >::use_rel_.
|
inline |
Definition at line 49 of file ROL_ConstraintStatusTest.hpp.
Member Function Documentation
|
inlinevirtual |
Check algorithm status.
Reimplemented from ROL::StatusTest< Real >.
Definition at line 54 of file ROL_ConstraintStatusTest.hpp.
References ROL::AlgorithmState< Real >::cnorm, ROL::ConstraintStatusTest< Real >::ctol0_, ROL::ConstraintStatusTest< Real >::ctol_, ROL::EXITSTATUS_CONVERGED, ROL::EXITSTATUS_LAST, ROL::EXITSTATUS_MAXITER, ROL::EXITSTATUS_STEPTOL, ROL::AlgorithmState< Real >::gnorm, ROL::ConstraintStatusTest< Real >::gtol0_, ROL::ConstraintStatusTest< Real >::gtol_, ROL::AlgorithmState< Real >::iter, ROL::ConstraintStatusTest< Real >::max_iter_, ROL::AlgorithmState< Real >::snorm, ROL::AlgorithmState< Real >::statusFlag, ROL::ConstraintStatusTest< Real >::stol0_, ROL::ConstraintStatusTest< Real >::stol_, and ROL::ConstraintStatusTest< Real >::use_rel_.
Member Data Documentation
|
private |
Definition at line 27 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 27 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 28 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 28 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 29 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 29 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 30 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
|
private |
Definition at line 31 of file ROL_ConstraintStatusTest.hpp.
Referenced by ROL::ConstraintStatusTest< Real >::check(), and ROL::ConstraintStatusTest< Real >::ConstraintStatusTest().
The documentation for this class was generated from the following file:
