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

#include <ROL_Constraint_SerialSimOpt.hpp>

Inheritance diagram for ROL::ROL::StatusTest< Real >:

Public Member Functions
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	stol_
Real	stol0_
int	max_iter_
bool	use_rel_

Detailed Description

template<class Real>
class ROL::ROL::StatusTest< Real >

Definition at line 24 of file ROL_Constraint_SerialSimOpt.hpp.

Constructor & Destructor Documentation

~StatusTest()

template<class Real>

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

inlinevirtual

Definition at line 34 of file ROL_Constraint_SerialSimOpt.hpp.

StatusTest() [1/2]

template<class Real>

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

inline

Definition at line 36 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::CombinedStatusTest< Real >::add().

StatusTest() [2/2]

template<class Real>

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

inline

Definition at line 46 of file ROL_Constraint_SerialSimOpt.hpp.

Member Function Documentation

check()

template<class Real>

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

inlinevirtual

Check algorithm status.

If "Use Relative Tolerances" is set to "true" upon construction, the gradient and step tolerances are scaled by the norm of the initial gradient.

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

Definition at line 55 of file ROL_Constraint_SerialSimOpt.hpp.

Member Data Documentation

gtol_

template<class Real>

Real ROL::ROL::StatusTest< Real >::gtol_

private

Definition at line 27 of file ROL_Constraint_SerialSimOpt.hpp.

gtol0_

template<class Real>

Real ROL::ROL::StatusTest< Real >::gtol0_

private

Definition at line 27 of file ROL_Constraint_SerialSimOpt.hpp.

stol_

template<class Real>

Real ROL::ROL::StatusTest< Real >::stol_

private

Definition at line 28 of file ROL_Constraint_SerialSimOpt.hpp.

stol0_

template<class Real>

Real ROL::ROL::StatusTest< Real >::stol0_

private

Definition at line 28 of file ROL_Constraint_SerialSimOpt.hpp.

max_iter_

template<class Real>

int ROL::ROL::StatusTest< Real >::max_iter_

private

Definition at line 29 of file ROL_Constraint_SerialSimOpt.hpp.

use_rel_

template<class Real>

bool ROL::ROL::StatusTest< Real >::use_rel_

private

Definition at line 30 of file ROL_Constraint_SerialSimOpt.hpp.

---

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

• ROL_Constraint_SerialSimOpt.hpp