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 (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	gtol0_
Real	stol_
Real	stol0_
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

~StatusTest()

template<class Real>

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

inlinevirtual

Definition at line 34 of file ROL_StatusTest.hpp.

StatusTest() [1/2]

template<class Real>

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

inline

Definition at line 36 of file ROL_StatusTest.hpp.

References gtol0_, gtol_, max_iter_, stol0_, 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 46 of file ROL_StatusTest.hpp.

References gtol0_, gtol_, max_iter_, stol0_, stol_, and use_rel_.

Member Function Documentation

check()

template<class Real>

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

inlinevirtual

Check algorithm status.

If "Use Relative Tolerances" is set to "true" upon construction, the gradient and step tolerances are scaled by the norm of the initial gradient.

Reimplemented in StatusTest_PDAS< Real >.

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

Member Data Documentation

gtol_

template<class Real>

Real ROL::StatusTest< Real >::gtol_

private

Definition at line 27 of file ROL_StatusTest.hpp.

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

gtol0_

template<class Real>

Real ROL::StatusTest< Real >::gtol0_

private

Definition at line 27 of file ROL_StatusTest.hpp.

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

stol_

template<class Real>

Real ROL::StatusTest< Real >::stol_

private

Definition at line 28 of file ROL_StatusTest.hpp.

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

stol0_

template<class Real>

Real ROL::StatusTest< Real >::stol0_

private

Definition at line 28 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 29 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 30 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