ROL
Public Member Functions | Private Attributes | List of all members
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)
 Check algorithm status.
 
- 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 57 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

Member Function Documentation

◆ setData()

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

◆ check()

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

Member Data Documentation

◆ mu_

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

◆ epsilon_

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

◆ xbar_

template<class Real >
Ptr<const Vector<Real> > ROL::PH_StatusTest< Real >::xbar_
private

◆ tol_

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

◆ x_

template<class Real >
Ptr<Vector<Real> > ROL::PH_StatusTest< Real >::x_
private

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