ROL::BundleStatusTest< Real > Class Template Reference

#include <ROL_BundleStatusTest.hpp>

Inheritance diagram for ROL::BundleStatusTest< Real >:

Public Member Functions
virtual	~BundleStatusTest ()
	BundleStatusTest (ROL::ParameterList &parlist)
	BundleStatusTest (Real tol=1.e-6, 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	tol_
int	max_iter_

Detailed Description

template<class Real>
class ROL::BundleStatusTest< Real >

Definition at line 19 of file ROL_BundleStatusTest.hpp.

Constructor & Destructor Documentation

~BundleStatusTest()

template<class Real>

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

inlinevirtual

Definition at line 27 of file ROL_BundleStatusTest.hpp.

BundleStatusTest() [1/2]

template<class Real>

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

inline

Definition at line 29 of file ROL_BundleStatusTest.hpp.

References max_iter_, and tol_.

BundleStatusTest() [2/2]

template<class Real>

ROL::BundleStatusTest< Real >::BundleStatusTest ( Real tol = 1.e-6, int max_iter = 100 )

inline

Definition at line 35 of file ROL_BundleStatusTest.hpp.

References max_iter_, and tol_.

Member Function Documentation

check()

template<class Real>

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

inlinevirtual

Check algorithm status.

Definition at line 40 of file ROL_BundleStatusTest.hpp.

References ROL::AlgorithmState< Real >::aggregateGradientNorm, ROL::AlgorithmState< Real >::aggregateModelError, ROL::EXITSTATUS_CONVERGED, ROL::EXITSTATUS_LAST, ROL::EXITSTATUS_MAXITER, ROL::AlgorithmState< Real >::flag, ROL::AlgorithmState< Real >::iter, max_iter_, ROL::AlgorithmState< Real >::statusFlag, and tol_.

Member Data Documentation

tol_

template<class Real>

Real ROL::BundleStatusTest< Real >::tol_

private

Definition at line 22 of file ROL_BundleStatusTest.hpp.

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

max_iter_

template<class Real>

int ROL::BundleStatusTest< Real >::max_iter_

private

Definition at line 23 of file ROL_BundleStatusTest.hpp.

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

---

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

• ROL_BundleStatusTest.hpp