ROL::PH_StatusTest< Real > Class Template Reference

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)
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	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

PH_StatusTest()

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(), epsilon_, mu_, and x_.

Member Function Documentation

setData()

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 epsilon_, mu_, tol_, and xbar_.

check()

template<class Real>

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

inline

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, tol_, x_, and xbar_.

Member Data Documentation

mu_

template<class Real>

Real ROL::PH_StatusTest< Real >::mu_

private

Definition at line 26 of file ROL_PH_StatusTest.hpp.

Referenced by PH_StatusTest(), and setData().

epsilon_

template<class Real>

Real ROL::PH_StatusTest< Real >::epsilon_

private

Definition at line 27 of file ROL_PH_StatusTest.hpp.

Referenced by PH_StatusTest(), and setData().

xbar_

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 check(), and setData().

tol_

template<class Real>

Real ROL::PH_StatusTest< Real >::tol_

private

Definition at line 29 of file ROL_PH_StatusTest.hpp.

Referenced by check(), and setData().

x_

template<class Real>

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

private

Definition at line 30 of file ROL_PH_StatusTest.hpp.

Referenced by check(), and PH_StatusTest().

---

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

• ROL_PH_StatusTest.hpp