ROL
|
Provides an interface for a convex combination of the expected value and the higher moment coherent risk measure. More...
#include <ROL_HMCR.hpp>
Public Member Functions | |
HMCR (const Real prob, const Real lambda, const unsigned order, const Teuchos::RCP< PlusFunction< Real > > &pf) | |
Constructor. More... | |
HMCR (Teuchos::ParameterList &parlist) | |
Constructor. More... | |
void | reset (Teuchos::RCP< Vector< Real > > &x0, const Vector< Real > &x) |
Reset internal risk measure storage. Called for value and gradient computation. More... | |
void | reset (Teuchos::RCP< Vector< Real > > &x0, const Vector< Real > &x, Teuchos::RCP< Vector< Real > > &v0, const Vector< Real > &v) |
Reset internal risk measure storage. Called for Hessian-times-a-vector computation. More... | |
void | update (const Real val, const Real weight) |
Update internal risk measure storage for value computation. More... | |
Real | getValue (SampleGenerator< Real > &sampler) |
Return risk measure value. More... | |
void | update (const Real val, const Vector< Real > &g, const Real weight) |
Update internal risk measure storage for gradient computation. More... | |
void | getGradient (Vector< Real > &g, SampleGenerator< Real > &sampler) |
Return risk measure (sub)gradient. More... | |
void | update (const Real val, const Vector< Real > &g, const Real gv, const Vector< Real > &hv, const Real weight) |
Update internal risk measure storage for Hessian-time-a-vector computation. More... | |
void | getHessVec (Vector< Real > &hv, SampleGenerator< Real > &sampler) |
Return risk measure Hessian-times-a-vector. More... | |
![]() | |
virtual | ~RiskMeasure () |
RiskMeasure (void) | |
Private Member Functions | |
void | checkInputs (void) const |
Private Attributes | |
Teuchos::RCP< PlusFunction< Real > > | plusFunction_ |
Real | prob_ |
Real | lambda_ |
unsigned | order_ |
Real | coeff_ |
Teuchos::RCP< Vector< Real > > | mDualVector0_ |
Teuchos::RCP< Vector< Real > > | gDualVector0_ |
Teuchos::RCP< Vector< Real > > | mDualVector1_ |
Teuchos::RCP< Vector< Real > > | gDualVector1_ |
Real | xvar_ |
Real | vvar_ |
Real | pnorm_ |
Real | coeff0_ |
Real | coeff1_ |
Real | coeff2_ |
bool | HMCR_firstReset_ |
Additional Inherited Members | |
![]() | |
Real | val_ |
Real | gv_ |
Teuchos::RCP< Vector< Real > > | g_ |
Teuchos::RCP< Vector< Real > > | hv_ |
Teuchos::RCP< Vector< Real > > | dualVector_ |
bool | firstReset_ |
Provides an interface for a convex combination of the expected value and the higher moment coherent risk measure.
The higher moment coherent risk measure of order \(p\) with confidence level \(0\le \beta < 1\) is
\[ \mathcal{R}(X) = \inf_{t\in\mathbb{R}} \left\{ t + \frac{1}{1-\beta} \mathbb{E}\left[(X-t)_+^p\right]^{1/p} \right\} \]
where \((x)_+ = \max\{0,x\}\). \(\mathcal{R}\) is a law-invariant coherent risk measure. ROL implements this by augmenting the optimization vector \(x_0\) with the parameter \(t\), then minimizes jointly for \((x_0,t)\).
The user can provide a smooth approximation of \((\cdot)_+\) using the ROL::PlusFunction class.
Definition at line 75 of file ROL_HMCR.hpp.
|
inline |
Constructor.
[in] | prob | is the confidence level |
[in] | lambda | is the convex combination parameter (lambda=0 corresponds to the expected value whereas lambda=1 corresponds to the higher moment coherent risk measure) |
[in] | order | is the order of higher moment coherent risk measure |
[in] | pf | is the plus function or an approximation |
Definition at line 129 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::checkInputs(), ROL::HMCR< Real >::coeff_, and ROL::HMCR< Real >::prob_.
Constructor.
[in] | parlist | is a parameter list specifying inputs |
parlist should contain sublists "SOL"->"Risk Measure"->"HMCR" and within the "HMCR" sublist should have the following parameters
Definition at line 151 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::checkInputs(), ROL::HMCR< Real >::coeff_, ROL::HMCR< Real >::lambda_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::plusFunction_, and ROL::HMCR< Real >::prob_.
|
inlineprivate |
Definition at line 107 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::lambda_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::plusFunction_, and ROL::HMCR< Real >::prob_.
Referenced by ROL::HMCR< Real >::HMCR().
|
inlinevirtual |
Reset internal risk measure storage. Called for value and gradient computation.
[out] | x0 | is a user-provided optimization vector |
[in] | x | is a (potentially) augmented risk vector On input, \form#56 carries \form#323 and any statistics (scalars) associated with the risk measure. |
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 169 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff0_, ROL::HMCR< Real >::gDualVector0_, ROL::HMCR< Real >::gDualVector1_, ROL::HMCR< Real >::HMCR_firstReset_, ROL::HMCR< Real >::mDualVector0_, ROL::HMCR< Real >::mDualVector1_, ROL::HMCR< Real >::pnorm_, ROL::RiskMeasure< Real >::reset(), and ROL::HMCR< Real >::xvar_.
Referenced by ROL::HMCR< Real >::reset().
|
inlinevirtual |
Reset internal risk measure storage. Called for Hessian-times-a-vector computation.
[out] | x0 | is a user-provided optimization vector |
[in] | x | is a (potentially) augmented risk vector |
[out] | v0 | is a user-provided direction vector |
[in] | v | is a (potentially) augmented risk vector On input, \form#56 carries \form#323 and any statistics (scalars) associated with the risk measure. Similarly, \form#37 carries\(v_0\) and any statistics (scalars) associated with the risk measure. |
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 186 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff1_, ROL::HMCR< Real >::coeff2_, ROL::HMCR< Real >::gDualVector1_, ROL::HMCR< Real >::mDualVector1_, ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::vvar_.
|
inlinevirtual |
Update internal risk measure storage for value computation.
[in] | val | is the value of the random variable objective function at the current sample point |
[in] | weight | is the weight associated with the current sample point |
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 198 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::order_, ROL::HMCR< Real >::plusFunction_, ROL::HMCR< Real >::pnorm_, and ROL::HMCR< Real >::xvar_.
|
inlinevirtual |
Return risk measure value.
[in] | sampler | is the ROL::SampleGenerator used to sample the objective function |
Upon return, getValue returns \(\mathcal{R}(f(x_0))\) where \(f(x_0)\) denotes the random variable objective function evaluated at \(x_0\).
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 207 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff_, ROL::HMCR< Real >::lambda_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::pnorm_, ROL::SampleGenerator< Real >::sumAll(), and ROL::HMCR< Real >::xvar_.
|
inlinevirtual |
Update internal risk measure storage for gradient computation.
[in] | val | is the value of the random variable objective function at the current sample point |
[in] | g | is the gradient of the random variable objective function at the current sample point |
[in] | weight | is the weight associated with the current sample point |
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 218 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff0_, ROL::HMCR< Real >::mDualVector0_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::plusFunction_, ROL::HMCR< Real >::pnorm_, and ROL::HMCR< Real >::xvar_.
|
inlinevirtual |
Return risk measure (sub)gradient.
[out] | g | is the (sub)gradient of the risk measure |
[in] | sampler | is the ROL::SampleGenerator used to sample the objective function |
Upon return, getGradient returns \(\theta\in\partial\mathcal{R}(f(x_0))\) where \(f(x_0)\) denotes the random variable objective function evaluated at \(x_0\) and \(\partial\mathcal{R}(X)\) denotes the subdifferential of \(\mathcal{R}\) at \(X\).
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 237 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff0_, ROL::HMCR< Real >::coeff_, ROL::HMCR< Real >::gDualVector0_, ROL::HMCR< Real >::lambda_, ROL::HMCR< Real >::mDualVector0_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::pnorm_, and ROL::SampleGenerator< Real >::sumAll().
|
inlinevirtual |
Update internal risk measure storage for Hessian-time-a-vector computation.
[in] | val | is the value of the random variable objective function at the current sample point |
[in] | g | is the gradient of the random variable objective function at the current sample point |
[in] | gv | is the gradient of the random variable objective function at the current sample point applied to the vector v0 |
[in] | hv | is the Hessian of the random variable objective function at the current sample point applied to the vector v0 |
[in] | weight | is the weight associated with the current sample point |
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 262 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff0_, ROL::HMCR< Real >::coeff1_, ROL::HMCR< Real >::coeff2_, ROL::HMCR< Real >::mDualVector0_, ROL::HMCR< Real >::mDualVector1_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::plusFunction_, ROL::HMCR< Real >::pnorm_, ROL::HMCR< Real >::vvar_, and ROL::HMCR< Real >::xvar_.
|
inlinevirtual |
Return risk measure Hessian-times-a-vector.
[out] | hv | is the Hessian-times-a-vector of the risk measure |
[in] | sampler | is the ROL::SampleGenerator used to sample the objective function |
Upon return, getHessVec returns \(\nabla^2 \mathcal{R}(f(x_0))v_0\) (if available) where \(f(x_0)\) denotes the random variable objective function evaluated at \(x_0\).
Reimplemented from ROL::RiskMeasure< Real >.
Definition at line 292 of file ROL_HMCR.hpp.
References ROL::HMCR< Real >::coeff0_, ROL::HMCR< Real >::coeff1_, ROL::HMCR< Real >::coeff2_, ROL::HMCR< Real >::coeff_, ROL::HMCR< Real >::gDualVector0_, ROL::HMCR< Real >::gDualVector1_, ROL::HMCR< Real >::lambda_, ROL::HMCR< Real >::mDualVector0_, ROL::HMCR< Real >::mDualVector1_, ROL::HMCR< Real >::order_, ROL::HMCR< Real >::pnorm_, and ROL::SampleGenerator< Real >::sumAll().
|
private |
Definition at line 78 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::checkInputs(), ROL::HMCR< Real >::HMCR(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 81 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::checkInputs(), and ROL::HMCR< Real >::HMCR().
|
private |
Definition at line 82 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::checkInputs(), ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::getValue(), and ROL::HMCR< Real >::HMCR().
|
private |
Definition at line 83 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::checkInputs(), ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::getValue(), ROL::HMCR< Real >::HMCR(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 86 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::getValue(), and ROL::HMCR< Real >::HMCR().
Definition at line 89 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
Definition at line 90 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), and ROL::HMCR< Real >::reset().
Definition at line 91 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
Definition at line 92 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getHessVec(), and ROL::HMCR< Real >::reset().
|
private |
Definition at line 95 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getValue(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 96 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 99 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::getValue(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 100 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getGradient(), ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 101 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 102 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::getHessVec(), ROL::HMCR< Real >::reset(), and ROL::HMCR< Real >::update().
|
private |
Definition at line 105 of file ROL_HMCR.hpp.
Referenced by ROL::HMCR< Real >::reset().