ROL::BundleStatusTest< Real > Class Template Reference

#include <ROL_BundleStatusTest.hpp>

Inheritance diagram for ROL::BundleStatusTest< Real >:

Public Member Functions
virtual	~BundleStatusTest ()
	BundleStatusTest (Teuchos::ParameterList &parlist)
	BundleStatusTest (Real tol=1.e-6, 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 (Teuchos::ParameterList &parlist)
	StatusTest (Real gtol=1.e-6, Real stol=1.e-12, int max_iter=100)

Private Attributes
Real	tol_
int	max_iter_

Detailed Description

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

Definition at line 53 of file ROL_BundleStatusTest.hpp.

Constructor & Destructor Documentation

~BundleStatusTest()

template<class Real >

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

inlinevirtual

Definition at line 61 of file ROL_BundleStatusTest.hpp.

BundleStatusTest() [1/2]

template<class Real >

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

inline

Definition at line 63 of file ROL_BundleStatusTest.hpp.

BundleStatusTest() [2/2]

template<class Real >

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

inline

Definition at line 69 of file ROL_BundleStatusTest.hpp.

Member Function Documentation

check()

template<class Real >

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

inlinevirtual

Check algorithm status.

Reimplemented from ROL::StatusTest< Real >.

Definition at line 74 of file ROL_BundleStatusTest.hpp.

References ROL::AlgorithmState< Real >::aggregateGradientNorm, ROL::AlgorithmState< Real >::aggregateModelError, ROL::AlgorithmState< Real >::flag, and ROL::AlgorithmState< Real >::iter.

Member Data Documentation

tol_

template<class Real >

Real ROL::BundleStatusTest< Real >::tol_

private

Definition at line 56 of file ROL_BundleStatusTest.hpp.

max_iter_

template<class Real >

int ROL::BundleStatusTest< Real >::max_iter_

private

Definition at line 57 of file ROL_BundleStatusTest.hpp.

---

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

• ROL_BundleStatusTest.hpp