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)

virtual bool	check (AlgorithmState< Real > &state)
	Check algorithm status. More...

Public Member Functions inherited from ROL::StatusTest< Real >
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)

Private Attributes
Real	gtol_

Real	ctol_

Real	stol_

int	max_iter_

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

template<class Real >

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

inlinevirtual

Definition at line 34 of file ROL_ConstraintStatusTest.hpp.

template<class Real >

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

inline

Definition at line 36 of file ROL_ConstraintStatusTest.hpp.

References ROL::ConstraintStatusTest< Real >::ctol_, ROL::ConstraintStatusTest< Real >::gtol_, ROL::ConstraintStatusTest< Real >::max_iter_, and ROL::ConstraintStatusTest< Real >::stol_.

template<class Real >

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

inline

Definition at line 44 of file ROL_ConstraintStatusTest.hpp.

Member Function Documentation

template<class Real >

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

inlinevirtual

Check algorithm status.

Reimplemented from ROL::StatusTest< Real >.

Definition at line 49 of file ROL_ConstraintStatusTest.hpp.

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

Member Data Documentation

template<class Real >

Real ROL::ConstraintStatusTest< Real >::gtol_

private

Definition at line 27 of file ROL_ConstraintStatusTest.hpp.

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

template<class Real >

Real ROL::ConstraintStatusTest< Real >::ctol_

private

Definition at line 28 of file ROL_ConstraintStatusTest.hpp.

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

template<class Real >

Real ROL::ConstraintStatusTest< Real >::stol_

private

Definition at line 29 of file ROL_ConstraintStatusTest.hpp.

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

template<class Real >

int ROL::ConstraintStatusTest< Real >::max_iter_

private

Definition at line 30 of file ROL_ConstraintStatusTest.hpp.

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

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

ROL_ConstraintStatusTest.hpp