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

ROL

Provides an interface to check status of the progressive hedging algorithm. More...

#include <ROL_PH_StatusTest.hpp>

Inheritance diagram for ROL::PH_StatusTest< Real >:

Public Member Functions
	PH_StatusTest (ROL::ParameterList &parlist, const Vector< Real > &x)

void	setData (const int iter, const Ptr< const Vector< Real >> &xbar)

bool	check (AlgorithmState< Real > &state)
	Check algorithm status. More...

Public Member Functions inherited from ROL::StatusTest< Real >
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)

Private Attributes
Real	mu_

Real	epsilon_

Ptr< const Vector< Real > >	xbar_

Real	tol_

Ptr< Vector< Real > >	x_

Detailed Description

template<class Real>
class ROL::PH_StatusTest< Real >

Provides an interface to check status of the progressive hedging algorithm.

Definition at line 23 of file ROL_PH_StatusTest.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::PH_StatusTest< Real >::PH_StatusTest	(	ROL::ParameterList &	parlist,
		const Vector< Real > &	x
	)

inline

Definition at line 34 of file ROL_PH_StatusTest.hpp.

References ROL::Vector< Real >::clone(), ROL::PH_StatusTest< Real >::epsilon_, ROL::PH_StatusTest< Real >::mu_, and ROL::PH_StatusTest< Real >::x_.

Member Function Documentation

template<class Real >

void ROL::PH_StatusTest< Real >::setData	(	const int	iter,
		const Ptr< const Vector< Real >> &	xbar
	)

inline

Definition at line 40 of file ROL_PH_StatusTest.hpp.

References ROL::PH_StatusTest< Real >::epsilon_, ROL::PH_StatusTest< Real >::mu_, ROL::PH_StatusTest< Real >::tol_, and ROL::PH_StatusTest< Real >::xbar_.

template<class Real >

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

inlinevirtual

Check algorithm status.

Reimplemented from ROL::StatusTest< Real >.

Definition at line 46 of file ROL_PH_StatusTest.hpp.

References ROL::EXITSTATUS_USERDEFINED, ROL::AlgorithmState< Real >::gnorm, ROL::AlgorithmState< Real >::iterateVec, ROL::AlgorithmState< Real >::statusFlag, ROL::PH_StatusTest< Real >::tol_, ROL::PH_StatusTest< Real >::x_, and ROL::PH_StatusTest< Real >::xbar_.

Member Data Documentation

template<class Real >

Real ROL::PH_StatusTest< Real >::mu_

private

Definition at line 26 of file ROL_PH_StatusTest.hpp.

Referenced by ROL::PH_StatusTest< Real >::PH_StatusTest(), and ROL::PH_StatusTest< Real >::setData().

template<class Real >

Real ROL::PH_StatusTest< Real >::epsilon_

private

Definition at line 27 of file ROL_PH_StatusTest.hpp.

Referenced by ROL::PH_StatusTest< Real >::PH_StatusTest(), and ROL::PH_StatusTest< Real >::setData().

template<class Real >

Ptr<const Vector<Real> > ROL::PH_StatusTest< Real >::xbar_

private

Definition at line 28 of file ROL_PH_StatusTest.hpp.

Referenced by ROL::PH_StatusTest< Real >::check(), and ROL::PH_StatusTest< Real >::setData().

template<class Real >

Real ROL::PH_StatusTest< Real >::tol_

private

Definition at line 29 of file ROL_PH_StatusTest.hpp.

Referenced by ROL::PH_StatusTest< Real >::check(), and ROL::PH_StatusTest< Real >::setData().

template<class Real >

Ptr<Vector<Real> > ROL::PH_StatusTest< Real >::x_

private

Definition at line 30 of file ROL_PH_StatusTest.hpp.

Referenced by ROL::PH_StatusTest< Real >::check(), and ROL::PH_StatusTest< Real >::PH_StatusTest().

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

ROL_PH_StatusTest.hpp