ROL
ROL::ExpectationQuadRisk< Real > Class Template Reference

#include <ROL_ExpectationQuadRisk.hpp>

Inheritance diagram for ROL::ExpectationQuadRisk< Real >:

Public Member Functions

 ExpectationQuadRisk (const Ptr< ExpectationQuad< Real > > &eq)
void checkRegret (void)
 Run derivative tests for the scalar regret function.
void updateValue (Objective< Real > &obj, const Vector< Real > &x, const std::vector< Real > &xstat, Real &tol)
void updateGradient (Objective< Real > &obj, const Vector< Real > &x, const std::vector< Real > &xstat, Real &tol)
void updateHessVec (Objective< Real > &obj, const Vector< Real > &v, const std::vector< Real > &vstat, const Vector< Real > &x, const std::vector< Real > &xstat, Real &tol)
Real getValue (const Vector< Real > &x, const std::vector< Real > &xstat, SampleGenerator< Real > &sampler)
void getGradient (Vector< Real > &g, std::vector< Real > &gstat, const Vector< Real > &x, const std::vector< Real > &xstat, SampleGenerator< Real > &sampler)
void getHessVec (Vector< Real > &hv, std::vector< Real > &hvstat, const Vector< Real > &v, const std::vector< Real > &vstat, const Vector< Real > &x, const std::vector< Real > &xstat, SampleGenerator< Real > &sampler)

Private Attributes

Ptr< ExpectationQuad< Real > > eq_

Detailed Description

template<class Real>
class ROL::ExpectationQuadRisk< Real >

Definition at line 55 of file ROL_ExpectationQuadRisk.hpp.

Constructor & Destructor Documentation

◆ ExpectationQuadRisk()

template<class Real>
ROL::ExpectationQuadRisk< Real >::ExpectationQuadRisk ( const Ptr< ExpectationQuad< Real > > & eq)
inline

Definition at line 74 of file ROL_ExpectationQuadRisk.hpp.

References eq_.

Member Function Documentation

◆ checkRegret()

template<class Real>
void ROL::ExpectationQuadRisk< Real >::checkRegret ( void )
inline

Run derivative tests for the scalar regret function.

Definition at line 79 of file ROL_ExpectationQuadRisk.hpp.

References eq_.

◆ updateValue()

template<class Real>
void ROL::ExpectationQuadRisk< Real >::updateValue ( Objective< Real > & obj,
const Vector< Real > & x,
const std::vector< Real > & xstat,
Real & tol )
inline

Definition at line 83 of file ROL_ExpectationQuadRisk.hpp.

References eq_.

◆ updateGradient()

template<class Real>
void ROL::ExpectationQuadRisk< Real >::updateGradient ( Objective< Real > & obj,
const Vector< Real > & x,
const std::vector< Real > & xstat,
Real & tol )
inline

Definition at line 92 of file ROL_ExpectationQuadRisk.hpp.

References eq_, and ROL::ROL_EPSILON().

◆ updateHessVec()

template<class Real>
void ROL::ExpectationQuadRisk< Real >::updateHessVec ( Objective< Real > & obj,
const Vector< Real > & v,
const std::vector< Real > & vstat,
const Vector< Real > & x,
const std::vector< Real > & xstat,
Real & tol )
inline

Definition at line 105 of file ROL_ExpectationQuadRisk.hpp.

References eq_, and ROL::ROL_EPSILON().

◆ getValue()

template<class Real>
Real ROL::ExpectationQuadRisk< Real >::getValue ( const Vector< Real > & x,
const std::vector< Real > & xstat,
SampleGenerator< Real > & sampler )
inline

◆ getGradient()

template<class Real>
void ROL::ExpectationQuadRisk< Real >::getGradient ( Vector< Real > & g,
std::vector< Real > & gstat,
const Vector< Real > & x,
const std::vector< Real > & xstat,
SampleGenerator< Real > & sampler )
inline

◆ getHessVec()

template<class Real>
void ROL::ExpectationQuadRisk< Real >::getHessVec ( Vector< Real > & hv,
std::vector< Real > & hvstat,
const Vector< Real > & v,
const std::vector< Real > & vstat,
const Vector< Real > & x,
const std::vector< Real > & xstat,
SampleGenerator< Real > & sampler )
inline

Member Data Documentation

◆ eq_

template<class Real>
Ptr<ExpectationQuad<Real> > ROL::ExpectationQuadRisk< Real >::eq_
private

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