ROL::CombinedStatusTest< Real > Class Template Reference

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

#include <ROL_CombinedStatusTest.hpp>

Inheritance diagram for ROL::CombinedStatusTest< Real >:

Public Member Functions
	CombinedStatusTest (void)
void	reset (void)
void	add (const Ptr< StatusTest< Real > > &status)
bool	check (AlgorithmState< Real > &state)
	Check algorithm status.
Public Member Functions inherited from 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)

Private Attributes
std::vector< Ptr< StatusTest< Real > > >	status_

Detailed Description

template<typename Real>
class ROL::CombinedStatusTest< Real >

Provides an interface to check two status tests of optimization algorithms.

Definition at line 23 of file ROL_CombinedStatusTest.hpp.

Constructor & Destructor Documentation

CombinedStatusTest()

template<typename Real >

ROL::CombinedStatusTest< Real >::CombinedStatusTest ( void  )

inline

Definition at line 28 of file ROL_CombinedStatusTest.hpp.

References ROL::CombinedStatusTest< Real >::status_.

Member Function Documentation

reset()

template<typename Real >

void ROL::CombinedStatusTest< Real >::reset ( void  )

inline

Definition at line 32 of file ROL_CombinedStatusTest.hpp.

References ROL::CombinedStatusTest< Real >::status_.

add()

template<typename Real >

void ROL::CombinedStatusTest< Real >::add ( const Ptr< StatusTest< Real > > &  status )

inline

Definition at line 36 of file ROL_CombinedStatusTest.hpp.

References ROL::CombinedStatusTest< Real >::status_.

check()

template<typename Real >

bool ROL::CombinedStatusTest< 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 from ROL::StatusTest< Real >.

Definition at line 40 of file ROL_CombinedStatusTest.hpp.

References ROL::CombinedStatusTest< Real >::status_.

Member Data Documentation

status_

template<typename Real >

std::vector<Ptr<StatusTest<Real> > > ROL::CombinedStatusTest< Real >::status_

private

Definition at line 25 of file ROL_CombinedStatusTest.hpp.

Referenced by ROL::CombinedStatusTest< Real >::add(), ROL::CombinedStatusTest< Real >::check(), ROL::CombinedStatusTest< Real >::CombinedStatusTest(), and ROL::CombinedStatusTest< Real >::reset().

---

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

• ROL_CombinedStatusTest.hpp