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

ROL

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.
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	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

◆ ~ConstraintStatusTest()

template<class Real>

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

inlinevirtual

Definition at line 35 of file ROL_ConstraintStatusTest.hpp.

◆ ConstraintStatusTest() [1/2]

template<class Real>

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

inline

Definition at line 37 of file ROL_ConstraintStatusTest.hpp.

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

◆ ConstraintStatusTest() [2/2]

template<class Real>

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

inline

Definition at line 49 of file ROL_ConstraintStatusTest.hpp.

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

Member Function Documentation

◆ check()

template<class Real>

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

inlinevirtual

Check algorithm status.

Definition at line 54 of file ROL_ConstraintStatusTest.hpp.

References ROL::AlgorithmState< Real >::cnorm, ctol0_, ctol_, ROL::EXITSTATUS_CONVERGED, ROL::EXITSTATUS_LAST, ROL::EXITSTATUS_MAXITER, 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::ConstraintStatusTest< Real >::gtol_

private

Definition at line 27 of file ROL_ConstraintStatusTest.hpp.

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

◆ gtol0_

template<class Real>

Real ROL::ConstraintStatusTest< Real >::gtol0_

private

Definition at line 27 of file ROL_ConstraintStatusTest.hpp.

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

◆ ctol_

template<class Real>

Real ROL::ConstraintStatusTest< Real >::ctol_

private

Definition at line 28 of file ROL_ConstraintStatusTest.hpp.

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

◆ ctol0_

template<class Real>

Real ROL::ConstraintStatusTest< Real >::ctol0_

private

Definition at line 28 of file ROL_ConstraintStatusTest.hpp.

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

◆ stol_

template<class Real>

Real ROL::ConstraintStatusTest< Real >::stol_

private

Definition at line 29 of file ROL_ConstraintStatusTest.hpp.

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

◆ stol0_

template<class Real>

Real ROL::ConstraintStatusTest< Real >::stol0_

private

Definition at line 29 of file ROL_ConstraintStatusTest.hpp.

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

◆ max_iter_

template<class Real>

int ROL::ConstraintStatusTest< Real >::max_iter_

private

Definition at line 30 of file ROL_ConstraintStatusTest.hpp.

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

◆ use_rel_

template<class Real>

bool ROL::ConstraintStatusTest< Real >::use_rel_

private

Definition at line 31 of file ROL_ConstraintStatusTest.hpp.

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

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

ROL_ConstraintStatusTest.hpp