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 Teuchos::RCP< PositiveFunction< Real > > &pf) | |
Constructor. More... | |
MeanDeviationFromTarget (const std::vector< Real > &target, const std::vector< Real > &order, const std::vector< Real > &coeff, const Teuchos::RCP< PositiveFunction< Real > > &pf) | |
Constructor. More... | |
MeanDeviationFromTarget (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... | |
void | update (const Real val, const Vector< Real > &g, const Real weight) |
Update internal risk measure storage for gradient computation. 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... | |
Real | getValue (SampleGenerator< Real > &sampler) |
Return risk measure value. More... | |
void | getGradient (Vector< Real > &g, SampleGenerator< Real > &sampler) |
Return risk measure (sub)gradient. More... | |
void | getHessVec (Vector< Real > &hv, SampleGenerator< Real > &sampler) |
Return risk measure Hessian-times-a-vector. More... | |
![]() | |
virtual | ~RiskMeasure () |
RiskMeasure (void) | |
Private Types | |
typedef std::vector< Real >::size_type | uint |
Private Member Functions | |
void | initialize (void) |
void | checkInputs (void) const |
Private Attributes | |
Teuchos::RCP< PositiveFunction< Real > > | positiveFunction_ |
Teuchos::RCP< Vector< Real > > | dualVector1_ |
Teuchos::RCP< Vector< Real > > | dualVector2_ |
Teuchos::RCP< Vector< Real > > | dualVector3_ |
Teuchos::RCP< Vector< Real > > | dualVector4_ |
std::vector< Real > | target_ |
std::vector< Real > | order_ |
std::vector< Real > | coeff_ |
uint | NumMoments_ |
std::vector< Real > | pval_ |
std::vector< Real > | pgv_ |
std::vector< Teuchos::RCP< Vector< Real > > > | pg0_ |
std::vector< Teuchos::RCP< Vector< Real > > > | pg_ |
std::vector< Teuchos::RCP< Vector< Real > > > | phv_ |
bool | 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 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 78 of file ROL_MeanDeviationFromTarget.hpp.
|
private |
Definition at line 79 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 140 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::initialize(), 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 161 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::initialize(), 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 193 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::initialize(), ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
inlineprivate |
Definition at line 102 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 >::MeanDeviationFromTarget().
|
inlineprivate |
Definition at line 112 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, and ROL::MeanDeviationFromTarget< Real >::target_.
Referenced by ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget().
|
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 225 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::dualVector1_, ROL::MeanDeviationFromTarget< Real >::dualVector2_, ROL::MeanDeviationFromTarget< Real >::dualVector3_, ROL::MeanDeviationFromTarget< Real >::dualVector4_, ROL::MeanDeviationFromTarget< Real >::firstReset_, 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 ROL::RiskMeasure< Real >::reset().
Referenced by ROL::MeanDeviationFromTarget< 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 248 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::RiskVector< Real >::getVector(), and ROL::MeanDeviationFromTarget< Real >::reset().
|
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 255 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, ROL::MeanDeviationFromTarget< Real >::pval_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
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 265 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::positiveFunction_, ROL::MeanDeviationFromTarget< Real >::pval_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
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 278 of file ROL_MeanDeviationFromTarget.hpp.
References 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_, and ROL::MeanDeviationFromTarget< Real >::target_.
|
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 301 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pval_, and ROL::SampleGenerator< Real >::sumAll().
|
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 312 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::dualVector1_, ROL::MeanDeviationFromTarget< Real >::NumMoments_, ROL::MeanDeviationFromTarget< Real >::order_, ROL::MeanDeviationFromTarget< Real >::pg_, ROL::MeanDeviationFromTarget< Real >::pval_, and ROL::SampleGenerator< Real >::sumAll().
|
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 329 of file ROL_MeanDeviationFromTarget.hpp.
References ROL::MeanDeviationFromTarget< Real >::coeff_, ROL::MeanDeviationFromTarget< Real >::dualVector1_, ROL::MeanDeviationFromTarget< Real >::dualVector2_, ROL::MeanDeviationFromTarget< Real >::dualVector3_, ROL::MeanDeviationFromTarget< Real >::dualVector4_, 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_, and ROL::SampleGenerator< Real >::sumAll().
|
private |
Definition at line 81 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget(), and ROL::MeanDeviationFromTarget< Real >::update().
|
private |
Definition at line 83 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), and ROL::MeanDeviationFromTarget< Real >::reset().
|
private |
Definition at line 84 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getHessVec(), and ROL::MeanDeviationFromTarget< Real >::reset().
|
private |
Definition at line 85 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getHessVec(), and ROL::MeanDeviationFromTarget< Real >::reset().
|
private |
Definition at line 86 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getHessVec(), and ROL::MeanDeviationFromTarget< Real >::reset().
|
private |
Definition at line 88 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::checkInputs(), ROL::MeanDeviationFromTarget< Real >::MeanDeviationFromTarget(), and ROL::MeanDeviationFromTarget< Real >::update().
|
private |
Definition at line 89 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(), and ROL::MeanDeviationFromTarget< Real >::update().
|
private |
Definition at line 90 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 91 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 >::MeanDeviationFromTarget(), ROL::MeanDeviationFromTarget< Real >::reset(), and ROL::MeanDeviationFromTarget< Real >::update().
|
private |
Definition at line 93 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 >::reset(), and ROL::MeanDeviationFromTarget< Real >::update().
|
private |
|
private |
|
private |
Definition at line 97 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::getGradient(), ROL::MeanDeviationFromTarget< Real >::getHessVec(), ROL::MeanDeviationFromTarget< Real >::initialize(), ROL::MeanDeviationFromTarget< Real >::reset(), and ROL::MeanDeviationFromTarget< Real >::update().
|
private |
|
private |
Definition at line 100 of file ROL_MeanDeviationFromTarget.hpp.
Referenced by ROL::MeanDeviationFromTarget< Real >::reset().