ROL: ROL::FletcherStatusTest< Real > Class Template Reference

ROL

Provides an interface to check status of optimization algorithms for problems with equality constraints. More...

#include <ROL_FletcherStatusTest.hpp>

Inheritance diagram for ROL::FletcherStatusTest< Real >:

Public Member Functions
virtual	~FletcherStatusTest ()
	FletcherStatusTest (ROL::ParameterList &parlist)
	FletcherStatusTest (Real gtol=1e-6, Real ctol=1e-6, Real stol=1e-12, int max_iter=100)
virtual bool	check (AlgorithmState< Real > &state)
	Check algorithm status.
Public Member Functions inherited from ROL::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)
virtual bool	check (AlgorithmState< Real > &state)
	Check algorithm status.

Private Attributes
Real	gtol_
Real	ctol_
Real	stol_
int	max_iter_

Detailed Description

template<class Real>
class ROL::FletcherStatusTest< Real >

Provides an interface to check status of optimization algorithms for problems with equality constraints.

Definition at line 24 of file ROL_FletcherStatusTest.hpp.

Constructor & Destructor Documentation

◆ ~FletcherStatusTest()

template<class Real>

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

inlinevirtual

Definition at line 34 of file ROL_FletcherStatusTest.hpp.

◆ FletcherStatusTest() [1/2]

template<class Real>

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

inline

Definition at line 36 of file ROL_FletcherStatusTest.hpp.

References ctol_, gtol_, max_iter_, and stol_.

◆ FletcherStatusTest() [2/2]

template<class Real>

ROL::FletcherStatusTest< Real >::FletcherStatusTest	(	Real	gtol = 1e-6,
		Real	ctol = 1e-6,
		Real	stol = 1e-12,
		int	max_iter = 100 )

inline

Definition at line 44 of file ROL_FletcherStatusTest.hpp.

References ctol_, gtol_, max_iter_, and stol_.

Member Function Documentation

◆ check()

template<class Real>

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

inlinevirtual

Check algorithm status.

Definition at line 49 of file ROL_FletcherStatusTest.hpp.

References ROL::AlgorithmState< Real >::aggregateGradientNorm, ROL::AlgorithmState< Real >::cnorm, ctol_, ROL::EXITSTATUS_CONVERGED, ROL::EXITSTATUS_LAST, ROL::EXITSTATUS_MAXITER, ROL::EXITSTATUS_STEPTOL, ROL::AlgorithmState< Real >::flag, ROL::AlgorithmState< Real >::gnorm, gtol_, ROL::AlgorithmState< Real >::iter, max_iter_, ROL::AlgorithmState< Real >::snorm, ROL::AlgorithmState< Real >::statusFlag, and stol_.

Member Data Documentation

◆ gtol_

template<class Real>

Real ROL::FletcherStatusTest< Real >::gtol_

private

Definition at line 27 of file ROL_FletcherStatusTest.hpp.

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

◆ ctol_

template<class Real>

Real ROL::FletcherStatusTest< Real >::ctol_

private

Definition at line 28 of file ROL_FletcherStatusTest.hpp.

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

◆ stol_

template<class Real>

Real ROL::FletcherStatusTest< Real >::stol_

private

Definition at line 29 of file ROL_FletcherStatusTest.hpp.

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

◆ max_iter_

template<class Real>

int ROL::FletcherStatusTest< Real >::max_iter_

private

Definition at line 30 of file ROL_FletcherStatusTest.hpp.

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

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

ROL_FletcherStatusTest.hpp