ROL::StatusTest< Real > Class Template Reference

Provides an interface to check status of optimization algorithms. More...

#include <ROL_StatusTest.hpp>

Inheritance diagram for ROL::StatusTest< Real >:

Public Member Functions
virtual	~StatusTest ()
	StatusTest (ROL::ParameterList &parlist)
	StatusTest (Real gtol=1.e-6, Real stol=1.e-12, int max_iter=100, bool use_rel=false)
virtual bool	check (AlgorithmState< Real > &state)
	Check algorithm status. More...

Private Attributes
Real	gtol_
Real	stol_
int	max_iter_
bool	use_rel_

Detailed Description

template<class Real>
class ROL::StatusTest< Real >

Provides an interface to check status of optimization algorithms.

Definition at line 24 of file ROL_StatusTest.hpp.

Constructor & Destructor Documentation

template<class Real >

virtual ROL::StatusTest< Real >::~StatusTest ( )

inlinevirtual

Definition at line 34 of file ROL_StatusTest.hpp.

template<class Real >

ROL::StatusTest< Real >::StatusTest ( ROL::ParameterList &  parlist )

inline

Definition at line 36 of file ROL_StatusTest.hpp.

References ROL::StatusTest< Real >::gtol_, ROL::StatusTest< Real >::max_iter_, ROL::StatusTest< Real >::stol_, and ROL::StatusTest< Real >::use_rel_.

template<class Real >

ROL::StatusTest< Real >::StatusTest ( Real  gtol = 1.e-6, Real  stol = 1.e-12, int  max_iter = 100, bool  use_rel = false  )

inline

Definition at line 44 of file ROL_StatusTest.hpp.

Member Function Documentation

template<class Real >

virtual bool ROL::StatusTest< Real >::check ( AlgorithmState< Real > &  state )

inlinevirtual

Check algorithm status.

Reimplemented in StatusTest_PDAS< Real >, ROL::ConstraintStatusTest< Real >, ROL::FletcherStatusTest< Real >, ROL::PH_StatusTest< Real >, ROL::BundleStatusTest< Real >, and ROL::CombinedStatusTest< Real >.

Definition at line 49 of file ROL_StatusTest.hpp.

References ROL::EXITSTATUS_CONVERGED, ROL::EXITSTATUS_LAST, ROL::EXITSTATUS_MAXITER, ROL::EXITSTATUS_NAN, ROL::EXITSTATUS_STEPTOL, ROL::AlgorithmState< Real >::gnorm, ROL::StatusTest< Real >::gtol_, ROL::AlgorithmState< Real >::iter, ROL::StatusTest< Real >::max_iter_, ROL::AlgorithmState< Real >::snorm, ROL::AlgorithmState< Real >::statusFlag, ROL::StatusTest< Real >::stol_, and ROL::StatusTest< Real >::use_rel_.

Member Data Documentation

template<class Real >

Real ROL::StatusTest< Real >::gtol_

private

Definition at line 27 of file ROL_StatusTest.hpp.

Referenced by ROL::StatusTest< Real >::check(), and ROL::StatusTest< Real >::StatusTest().

template<class Real >

Real ROL::StatusTest< Real >::stol_

private

Definition at line 28 of file ROL_StatusTest.hpp.

Referenced by ROL::StatusTest< Real >::check(), and ROL::StatusTest< Real >::StatusTest().

template<class Real >

int ROL::StatusTest< Real >::max_iter_

private

Definition at line 29 of file ROL_StatusTest.hpp.

Referenced by ROL::StatusTest< Real >::check(), and ROL::StatusTest< Real >::StatusTest().

template<class Real >

bool ROL::StatusTest< Real >::use_rel_

private

Definition at line 30 of file ROL_StatusTest.hpp.

Referenced by ROL::StatusTest< Real >::check(), and ROL::StatusTest< Real >::StatusTest().

---

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

• ROL_StatusTest.hpp