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.

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 58 of file ROL_StatusTest.hpp.

Constructor & Destructor Documentation

~StatusTest()

template<class Real>

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

inlinevirtual

Definition at line 68 of file ROL_StatusTest.hpp.

StatusTest() [1/2]

template<class Real>

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

inline

Definition at line 70 of file ROL_StatusTest.hpp.

References gtol_, max_iter_, stol_, and use_rel_.

StatusTest() [2/2]

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 78 of file ROL_StatusTest.hpp.

References gtol_, max_iter_, stol_, and use_rel_.

Member Function Documentation

check()

template<class Real>

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

inlinevirtual

Check algorithm status.

Reimplemented in StatusTest_PDAS< Real >.

Definition at line 83 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, gtol_, ROL::AlgorithmState< Real >::iter, max_iter_, ROL::AlgorithmState< Real >::snorm, ROL::AlgorithmState< Real >::statusFlag, stol_, and use_rel_.

Member Data Documentation

gtol_

template<class Real>

Real ROL::StatusTest< Real >::gtol_

private

Definition at line 61 of file ROL_StatusTest.hpp.

Referenced by check(), StatusTest(), and StatusTest().

stol_

template<class Real>

Real ROL::StatusTest< Real >::stol_

private

Definition at line 62 of file ROL_StatusTest.hpp.

Referenced by check(), StatusTest(), and StatusTest().

max_iter_

template<class Real>

int ROL::StatusTest< Real >::max_iter_

private

Definition at line 63 of file ROL_StatusTest.hpp.

Referenced by check(), StatusTest(), and StatusTest().

use_rel_

template<class Real>

bool ROL::StatusTest< Real >::use_rel_

private

Definition at line 64 of file ROL_StatusTest.hpp.

Referenced by check(), StatusTest(), and StatusTest().

---

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

• ROL_StatusTest.hpp