ROL::PH_RegretObjective< Real > Class Template Reference

Provides the interface for the progressive hedging regret objective. More...

#include <ROL_PH_RegretObjective.hpp>

Inheritance diagram for ROL::PH_RegretObjective< Real >:

Public Member Functions
	PH_RegretObjective (const Ptr< Objective< Real > > &obj, ParameterList &parlist)
void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
Real	value (const Vector< Real > &x, Real &tol)
void	gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
void	hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
void	setParameter (const std::vector< Real > &param)
Public Member Functions inherited from ROL::ROL::Objective< Real >
virtual	~Objective ()
	Objective ()
virtual void	update (const Vector< Real > &x, UpdateType type, int iter=-1)
	Update objective function.
virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update objective function.
virtual Real	value (const Vector< Real > &x, Real &tol)=0
	Compute value.
virtual void	gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
	Compute gradient.
virtual Real	dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
	Compute directional derivative.
virtual void	hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply Hessian approximation to vector.
virtual void	invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply inverse Hessian approximation to vector.
virtual void	precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply preconditioner to vector.
virtual void	prox (Vector< Real > &Pv, const Vector< Real > &v, Real t, Real &tol)
	Compute the proximity operator.
virtual void	proxJacVec (Vector< Real > &Jv, const Vector< Real > &v, const Vector< Real > &x, Real t, Real &tol)
	Apply the Jacobian of the proximity operator.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference gradient check.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference gradient check.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference gradient check with specified step sizes.
virtual std::vector< std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference gradient check with specified step sizes.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference Hessian-applied-to-vector check.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference Hessian-applied-to-vector check.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference Hessian-applied-to-vector check with specified step sizes.
virtual std::vector< std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference Hessian-applied-to-vector check with specified step sizes.
virtual std::vector< Real >	checkHessSym (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
	Hessian symmetry check.
virtual std::vector< Real >	checkHessSym (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
	Hessian symmetry check.
virtual std::vector< std::vector< Real > >	checkProxJacVec (const Vector< Real > &x, const Vector< Real > &v, Real t=Real(1), bool printToStream=true, std::ostream &outStream=std::cout, int numSteps=ROL_NUM_CHECKDERIV_STEPS)
	Finite-difference proximity operator Jacobian-applied-to-vector check.

Private Member Functions
void	getValue (const Vector< Real > &x, Real &tol)
void	getGradient (const Vector< Real > &x, Real &tol)

Private Attributes
const Ptr< Objective< Real > >	obj_
Ptr< ExpectationQuad< Real > >	quad_
bool	isValueComputed_
Real	val_
bool	isGradientInitialized_
bool	isGradientComputed_
Ptr< Vector< Real > >	g_

Additional Inherited Members
Protected Member Functions inherited from ROL::ROL::Objective< Real >
const std::vector< Real >	getParameter (void) const

Detailed Description

template<class Real>
class ROL::PH_RegretObjective< Real >

Provides the interface for the progressive hedging regret objective.

---

Definition at line 25 of file ROL_PH_RegretObjective.hpp.

Constructor & Destructor Documentation

PH_RegretObjective()

template<class Real>

ROL::PH_RegretObjective< Real >::PH_RegretObjective ( const Ptr< Objective< Real > > & obj, ParameterList & parlist )

inline

Definition at line 57 of file ROL_PH_RegretObjective.hpp.

References isGradientComputed_, isGradientInitialized_, isValueComputed_, obj_, ROL::ROL::Objective< Real >::Objective(), quad_, ROL::REGRETMEASURE_EXPONENTIAL, ROL::REGRETMEASURE_GENMOREAUYOSIDAMEANABSOLUTELOSS, ROL::REGRETMEASURE_LOGQUANTILE, ROL::REGRETMEASURE_MEANABSOLUTELOSS, ROL::REGRETMEASURE_MEANL2, ROL::REGRETMEASURE_MOREAUYOSIDAMEANABSOLUTELOSS, ROL::REGRETMEASURE_SMOOTHEDWORSTCASE, ROL::REGRETMEASURE_TRUNCATEDMEAN, and ROL::StringToERegretMeasure().

Member Function Documentation

getValue()

template<class Real>

void ROL::PH_RegretObjective< Real >::getValue ( const Vector< Real > & x, Real & tol )

inlineprivate

Definition at line 37 of file ROL_PH_RegretObjective.hpp.

References isValueComputed_, obj_, and val_.

Referenced by gradient(), hessVec(), and value().

getGradient()

template<class Real>

void ROL::PH_RegretObjective< Real >::getGradient ( const Vector< Real > & x, Real & tol )

inlineprivate

Definition at line 44 of file ROL_PH_RegretObjective.hpp.

References ROL::Vector< Real >::clone(), ROL::Vector< Real >::dual(), g_, isGradientComputed_, isGradientInitialized_, and obj_.

Referenced by gradient(), and hessVec().

update()

template<class Real>

void ROL::PH_RegretObjective< Real >::update ( const Vector< Real > & x, bool flag = true, int iter = -1 )

inline

Definition at line 88 of file ROL_PH_RegretObjective.hpp.

References isGradientComputed_, isValueComputed_, and obj_.

value()

template<class Real>

Real ROL::PH_RegretObjective< Real >::value ( const Vector< Real > & x, Real & tol )

inline

Definition at line 94 of file ROL_PH_RegretObjective.hpp.

References getValue(), quad_, and val_.

gradient()

template<class Real>

void ROL::PH_RegretObjective< Real >::gradient ( Vector< Real > & g, const Vector< Real > & x, Real & tol )

inline

Definition at line 100 of file ROL_PH_RegretObjective.hpp.

References g_, getGradient(), getValue(), quad_, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), and val_.

hessVec()

template<class Real>

void ROL::PH_RegretObjective< Real >::hessVec ( Vector< Real > & hv, const Vector< Real > & v, const Vector< Real > & x, Real & tol )

inline

Definition at line 107 of file ROL_PH_RegretObjective.hpp.

References ROL::Vector< Real >::apply(), ROL::Vector< Real >::axpy(), g_, getGradient(), getValue(), obj_, quad_, ROL::Vector< Real >::scale(), and val_.

setParameter()

template<class Real>

void ROL::PH_RegretObjective< Real >::setParameter ( const std::vector< Real > & param )

inlinevirtual

Reimplemented from ROL::ROL::Objective< Real >.

Definition at line 118 of file ROL_PH_RegretObjective.hpp.

References obj_, and ROL::Objective< Real >::setParameter().

Member Data Documentation

obj_

template<class Real>

const Ptr<Objective<Real> > ROL::PH_RegretObjective< Real >::obj_

private

Definition at line 27 of file ROL_PH_RegretObjective.hpp.

Referenced by getGradient(), getValue(), hessVec(), PH_RegretObjective(), setParameter(), and update().

quad_

template<class Real>

Ptr<ExpectationQuad<Real> > ROL::PH_RegretObjective< Real >::quad_

private

Definition at line 28 of file ROL_PH_RegretObjective.hpp.

Referenced by gradient(), hessVec(), PH_RegretObjective(), and value().

isValueComputed_

template<class Real>

bool ROL::PH_RegretObjective< Real >::isValueComputed_

private

Definition at line 30 of file ROL_PH_RegretObjective.hpp.

Referenced by getValue(), PH_RegretObjective(), and update().

val_

template<class Real>

Real ROL::PH_RegretObjective< Real >::val_

private

Definition at line 31 of file ROL_PH_RegretObjective.hpp.

Referenced by getValue(), gradient(), hessVec(), and value().

isGradientInitialized_

template<class Real>

bool ROL::PH_RegretObjective< Real >::isGradientInitialized_

private

Definition at line 33 of file ROL_PH_RegretObjective.hpp.

Referenced by getGradient(), and PH_RegretObjective().

isGradientComputed_

template<class Real>

bool ROL::PH_RegretObjective< Real >::isGradientComputed_

private

Definition at line 34 of file ROL_PH_RegretObjective.hpp.

Referenced by getGradient(), PH_RegretObjective(), and update().

g_

template<class Real>

Ptr<Vector<Real> > ROL::PH_RegretObjective< Real >::g_

private

Definition at line 35 of file ROL_PH_RegretObjective.hpp.

Referenced by getGradient(), gradient(), and hessVec().

---

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

• ROL_PH_RegretObjective.hpp