ROL
|
Provides an interface for the mean plus a sum of arbitrary order deviations from targets. More...
#include <ROL_MeanDeviationFromTarget.hpp>
Public Member Functions | |
MeanDeviationFromTarget (const Real target, const Real order, const Real coeff, const Ptr< PositiveFunction< Real > > &pf) | |
Constructor. More... | |
MeanDeviationFromTarget (const std::vector< Real > &target, const std::vector< Real > &order, const std::vector< Real > &coeff, const Ptr< PositiveFunction< Real > > &pf) | |
Constructor. More... | |
MeanDeviationFromTarget (ROL::ParameterList &parlist) | |
Constructor. More... | |
void | initialize (const Vector< Real > &x) |
Initialize temporary variables. More... | |
void | updateValue (Objective< Real > &obj, const Vector< Real > &x, const std::vector< Real > &xstat, Real &tol) |
Update internal storage for value computation. More... | |
Real | getValue (const Vector< Real > &x, const std::vector< Real > &xstat, SampleGenerator< Real > &sampler) |
Return risk measure value. More... | |
void | updateGradient (Objective< Real > &obj, const Vector< Real > &x, const std::vector< Real > &xstat, Real &tol) |
Update internal risk measure storage for gradient computation. More... | |
void | getGradient (Vector< Real > &g, std::vector< Real > &gstat, const Vector< Real > &x, const std::vector< Real > &xstat, SampleGenerator< Real > &sampler) |
Return risk measure (sub)gradient. More... | |
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) |
Update internal risk measure storage for Hessian-time-a-vector computation. More... | |
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) |
Return risk measure Hessian-times-a-vector. More... | |
Public Member Functions inherited from ROL::RandVarFunctional< Real > | |
virtual | ~RandVarFunctional () |
RandVarFunctional (void) | |
weight_ (0) | |
void | useStorage (bool storage) |
void | useHessVecStorage (bool storage) |
virtual void | setStorage (const Ptr< ScalarController< Real >> &value_storage, const Ptr< VectorController< Real >> &gradient_storage) |
virtual void | setHessVecStorage (const Ptr< ScalarController< Real >> &gradvec_storage, const Ptr< VectorController< Real >> &hessvec_storage) |
virtual void | resetStorage (bool flag=true) |
Reset internal storage. More... | |
virtual void | resetStorage (UpdateType type) |
virtual void | setSample (const std::vector< Real > &point, const Real weight) |
virtual Real | computeStatistic (const Ptr< const std::vector< Real >> &xstat) const |
Compute statistic. More... | |
Private Types | |
typedef std::vector< Real > ::size_type | uint |
Private Member Functions | |
void | initializeMDT (void) |
void | checkInputs (void) |
Private Attributes | |
Ptr< PositiveFunction< Real > > | positiveFunction_ |
std::vector< Real > | target_ |
std::vector< Real > | order_ |
std::vector< Real > | coeff_ |
uint | NumMoments_ |
std::vector< Real > | pval_ |
std::vector< Real > | pgv_ |
std::vector< Ptr< Vector< Real > > > | pg0_ |
std::vector< Ptr< Vector< Real > > > | pg_ |
std::vector< Ptr< Vector< Real > > > | phv_ |
bool | firstResetMDT_ |
Additional Inherited Members | |
Protected Member Functions inherited from ROL::RandVarFunctional< Real > | |
Real | computeValue (Objective< Real > &obj, const Vector< Real > &x, Real &tol) |
void | computeGradient (Vector< Real > &g, Objective< Real > &obj, const Vector< Real > &x, Real &tol) |
Real | computeGradVec (Vector< Real > &g, Objective< Real > &obj, const Vector< Real > &v, const Vector< Real > &x, Real &tol) |
void | computeHessVec (Vector< Real > &hv, Objective< Real > &obj, const Vector< Real > &v, const Vector< Real > &x, Real &tol) |
Protected Attributes inherited from ROL::RandVarFunctional< Real > | |
Real | val_ |
Real | gv_ |
Ptr< Vector< Real > > | g_ |
Ptr< Vector< Real > > | hv_ |
Ptr< Vector< Real > > | dualVector_ |
bool | firstReset_ |
std::vector< Real > | point_ |
Real | weight_ |
Provides an interface for the mean plus a sum of arbitrary order deviations from targets.
The mean plus deviations from targets risk measure is
\[ \mathcal{R}(X) = \mathbb{E}[X] + \sum_{k=1}^n c_k \mathbb{E}[\wp(X-t_k)^{p_k}]^{1/p_k} \]
where \(\wp:\mathbb{R}\to[0,\infty)\) is either the absolute value or \((x)_+ = \max\{0,x\}\), \(c_k > 0\) and \(p_k\in\mathbb{N}\). In general, \(\mathcal{R}\) is law-invariant, but not coherent since it violates translation equivariance.
When using derivative-based optimization, the user can provide a smooth approximation of \((\cdot)_+\) using the ROL::PositiveFunction class.
Definition at line 42 of file ROL_MeanDeviationFromTarget.hpp.
|
private |
Definition at line 43 of file ROL_MeanDeviationFromTarget.hpp.
|
inline |
Constructor.
[in] | target | is the target scalar value |
[in] | order | is the deviation order |
[in] | coeff | is the weight for deviation term |
[in] | pf | is the plus function or an approximation |
This constructor produces a mean plus deviation from target risk measure with a single deviation.
Definition at line 113 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
inline |
Constructor.
[in] | target | is a vector of targets |
[in] | order | is a vector of deviation orders |
[in] | coeff | is a vector of weights for the deviation terms |
[in] | pf | is the plus function or an approximation |
This constructor produces a mean plus deviation from target risk measure with an arbitrary number of deviations.
Definition at line 133 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
inline |
Constructor.
[in] | parlist | is a parameter list specifying inputs |
parlist should contain sublists "SOL"->"Risk Measure"->"Mean Plus Deviation From Target" and within the "Mean Plus Deviation From Target" sublist should have the following parameters
Definition at line 164 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
inlineprivate |
Definition at line 74 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::pg0_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::pgv_, ROL::MeanDeviationFromTarget< Real >::phv_, and ROL::MeanDeviationFromTarget< Real >::pval_.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs().
|
inlineprivate |
Definition at line 84 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::initializeMDT(), ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, ROL::MeanDeviationFromTarget< Real >::target_, and zero.
Referenced by ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget().
|
inlinevirtual |
Initialize temporary variables.
[in] | x | is a vector used for initializing storage |
Reimplemented from ROL::RandVarFunctional< Real >.
Definition at line 193 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::Vector< Real >::dual(), ROL::MeanDeviationFromTarget< Real >::firstResetMDT_, ROL::RandVarFunctional< Real >::initialize(), ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::pg0_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::pgv_, ROL::MeanDeviationFromTarget< Real >::phv_, ROL::MeanDeviationFromTarget< Real >::pval_, and zero.
|
inlinevirtual |
Update internal 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::RandVarFunctional< Real >.
Definition at line 210 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::RandVarFunctional< Real >::computeValue(), ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, ROL::MeanDeviationFromTarget< Real >::pval_, ROL::MeanDeviationFromTarget< Real >::target_, ROL::RandVarFunctional< Real >::val_, and ROL::RandVarFunctional< Real >::weight_.
|
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::RandVarFunctional< Real >.
Definition at line 224 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pval_, ROL::SampleGenerator< Real >::sumAll(), and ROL::RandVarFunctional< Real >::val_.
|
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::RandVarFunctional< Real >.
Definition at line 238 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::RandVarFunctional< Real >::computeGradient(), ROL::RandVarFunctional< Real >::computeValue(), ROL::RandVarFunctional< Real >::dualVector_, ROL::RandVarFunctional< Real >::g_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, ROL::MeanDeviationFromTarget< Real >::pval_, ROL::MeanDeviationFromTarget< Real >::target_, and ROL::RandVarFunctional< Real >::weight_.
|
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::RandVarFunctional< Real >.
Definition at line 256 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::Vector< Real >::axpy(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::RandVarFunctional< Real >::dualVector_, ROL::RandVarFunctional< Real >::g_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::pval_, ROL::SampleGenerator< Real >::sumAll(), and zero.
|
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::RandVarFunctional< Real >.
Definition at line 274 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::RandVarFunctional< Real >::computeGradVec(), ROL::RandVarFunctional< Real >::computeHessVec(), ROL::RandVarFunctional< Real >::computeValue(), ROL::RandVarFunctional< Real >::dualVector_, ROL::RandVarFunctional< Real >::g_, ROL::RandVarFunctional< Real >::hv_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pg0_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::pgv_, ROL::MeanDeviationFromTarget< Real >::phv_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, ROL::MeanDeviationFromTarget< Real >::pval_, ROL::MeanDeviationFromTarget< Real >::target_, and ROL::RandVarFunctional< Real >::weight_.
|
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::RandVarFunctional< Real >.
Definition at line 305 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::Vector< Real >::axpy(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::RandVarFunctional< Real >::dualVector_, ROL::RandVarFunctional< Real >::hv_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pg0_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::pgv_, ROL::MeanDeviationFromTarget< Real >::phv_, ROL::MeanDeviationFromTarget< Real >::pval_, ROL::SampleGenerator< Real >::sumAll(), and zero.
|
private |
Definition at line 45 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget(), ROL::MeanDeviationFromTarget< Real >::updateGradient(), ROL::MeanDeviationFromTarget< Real >::updateHessVec(), and ROL::MeanDeviationFromTarget< Real >::updateValue().
|
private |
Definition at line 46 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget(), ROL::MeanDeviationFromTarget< Real >::updateGradient(), ROL::MeanDeviationFromTarget< Real >::updateHessVec(), and ROL::MeanDeviationFromTarget< Real >::updateValue().
|
private |
Definition at line 47 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), ROL::MeanDeviationFromTarget< Real >::getValue(), ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget(), ROL::MeanDeviationFromTarget< Real >::updateGradient(), ROL::MeanDeviationFromTarget< Real >::updateHessVec(), and ROL::MeanDeviationFromTarget< Real >::updateValue().
|
private |
Definition at line 48 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), ROL::MeanDeviationFromTarget< Real >::getValue(), and ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget().
|
private |
Definition at line 49 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), ROL::MeanDeviationFromTarget< Real >::getValue(), ROL::MeanDeviationFromTarget< Real >::initialize(), ROL::MeanDeviationFromTarget< Real >::initializeMDT(), ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget(), ROL::MeanDeviationFromTarget< Real >::updateGradient(), ROL::MeanDeviationFromTarget< Real >::updateHessVec(), and ROL::MeanDeviationFromTarget< Real >::updateValue().
|
private |
Definition at line 51 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), ROL::MeanDeviationFromTarget< Real >::getValue(), ROL::MeanDeviationFromTarget< Real >::initialize(), ROL::MeanDeviationFromTarget< Real >::initializeMDT(), ROL::MeanDeviationFromTarget< Real >::updateGradient(), ROL::MeanDeviationFromTarget< Real >::updateHessVec(), and ROL::MeanDeviationFromTarget< Real >::updateValue().
|
private |
|
private |
|
private |
Definition at line 55 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), ROL::MeanDeviationFromTarget< Real >::initialize(), ROL::MeanDeviationFromTarget< Real >::initializeMDT(), ROL::MeanDeviationFromTarget< Real >::updateGradient(), and ROL::MeanDeviationFromTarget< Real >::updateHessVec().
|
private |
|
private |
Definition at line 58 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::initialize().