StatusTest Class Reference

Provides an interface to check status of optimization algorithms. More...

#include <ROL_StatusTest.hpp>

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

Provides an interface to check status of optimization algorithms.

Constructor & Destructor Documentation

~StatusTest()

virtual StatusTest::~StatusTest ( )

inlinevirtual

Definition at line 68 of file ROL_StatusTest.hpp.

StatusTest() [1/2]

StatusTest::StatusTest ( ROL::ParameterList & parlist )

inline

Definition at line 70 of file ROL_StatusTest.hpp.

References max_iter_.

StatusTest() [2/2]

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

Member Function Documentation

check()

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

inlinevirtual

Check algorithm status.

Reimplemented in CombinedStatusTest, ConstraintStatusTest, ROL::FletcherStatusTest< Real >, and ROL::PH_StatusTest< Real >.

Definition at line 83 of file ROL_StatusTest.hpp.

References max_iter_.

Member Data Documentation

gtol_

Real StatusTest::gtol_

private

Definition at line 61 of file ROL_StatusTest.hpp.

stol_

Real StatusTest::stol_

private

Definition at line 62 of file ROL_StatusTest.hpp.

max_iter_

int StatusTest::max_iter_

private

Definition at line 63 of file ROL_StatusTest.hpp.

use_rel_

bool StatusTest::use_rel_

private

Definition at line 64 of file ROL_StatusTest.hpp.

---

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

• ROL_StatusTest.hpp