ROL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROL::BPOEObjective< Real > Class Template Reference

#include <ROL_BPOEObjective.hpp>

+ Inheritance diagram for ROL::BPOEObjective< Real >:

Public Member Functions

virtual ~BPOEObjective ()
 
 BPOEObjective (const Teuchos::RCP< Objective< Real > > &pObj, const Real order, const Real threshold, const Teuchos::RCP< SampleGenerator< Real > > &vsampler, const Teuchos::RCP< SampleGenerator< Real > > &gsampler, const Teuchos::RCP< SampleGenerator< Real > > &hsampler, const bool storage=true)
 
 BPOEObjective (const Teuchos::RCP< Objective< Real > > &pObj, const Real order, const Real threshold, const Teuchos::RCP< SampleGenerator< Real > > &vsampler, const Teuchos::RCP< SampleGenerator< Real > > &gsampler, const bool storage=true)
 
 BPOEObjective (const Teuchos::RCP< Objective< Real > > &pObj, const Real order, const Real threshold, const Teuchos::RCP< SampleGenerator< Real > > &sampler, const bool storage=true)
 
void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update objective function. More...
 
Real value (const Vector< Real > &x, Real &tol)
 Compute value. More...
 
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
 Compute gradient. More...
 
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply Hessian approximation to vector. More...
 
virtual void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply preconditioner to vector. More...
 
- Public Member Functions inherited from ROL::Objective< Real >
virtual ~Objective ()
 
virtual Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
 Compute directional derivative. More...
 
virtual void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply inverse Hessian approximation to vector. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void setParameter (const std::vector< Real > &param)
 

Private Member Functions

void initialize (const Vector< Real > &x)
 
void unwrap_const_CVaR_vector (Teuchos::RCP< Vector< Real > > &xvec, Real &xvar, const Vector< Real > &x)
 
void getValue (Real &val, const Vector< Real > &x, const std::vector< Real > &param, Real &tol)
 
void getGradient (Vector< Real > &g, const Vector< Real > &x, const std::vector< Real > &param, Real &tol)
 
void getHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, const std::vector< Real > &param, Real &tol)
 

Private Attributes

Teuchos::RCP< Objective< Real > > ParametrizedObjective_
 
Real order_
 
Real threshold_
 
Teuchos::RCP< SampleGenerator< Real > > ValueSampler_
 
Teuchos::RCP< SampleGenerator< Real > > GradientSampler_
 
Teuchos::RCP< SampleGenerator< Real > > HessianSampler_
 
Teuchos::RCP< Vector< Real > > pointGrad_
 
Teuchos::RCP< Vector< Real > > pointHess_
 
Teuchos::RCP< Vector< Real > > gradient0_
 
Teuchos::RCP< Vector< Real > > sumGrad0_
 
Teuchos::RCP< Vector< Real > > gradient1_
 
Teuchos::RCP< Vector< Real > > sumGrad1_
 
Teuchos::RCP< Vector< Real > > gradient2_
 
Teuchos::RCP< Vector< Real > > sumGrad2_
 
Teuchos::RCP< Vector< Real > > hessvec_
 
Teuchos::RCP< Vector< Real > > sumHess_
 
bool storage_
 
bool initialized_
 
std::map< std::vector< Real >, Real > value_storage_
 
std::map< std::vector< Real >, Teuchos::RCP< Vector< Real > > > gradient_storage_
 

Additional Inherited Members

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

Detailed Description

template<class Real>
class ROL::BPOEObjective< Real >

Definition at line 55 of file ROL_BPOEObjective.hpp.

Constructor & Destructor Documentation

◆ ~BPOEObjective()

template<class Real >
virtual ROL::BPOEObjective< Real >::~BPOEObjective ( )
inlinevirtual

Definition at line 144 of file ROL_BPOEObjective.hpp.

◆ BPOEObjective() [1/3]

template<class Real >
ROL::BPOEObjective< Real >::BPOEObjective ( const Teuchos::RCP< Objective< Real > > &  pObj,
const Real  order,
const Real  threshold,
const Teuchos::RCP< SampleGenerator< Real > > &  vsampler,
const Teuchos::RCP< SampleGenerator< Real > > &  gsampler,
const Teuchos::RCP< SampleGenerator< Real > > &  hsampler,
const bool  storage = true 
)
inline

◆ BPOEObjective() [2/3]

template<class Real >
ROL::BPOEObjective< Real >::BPOEObjective ( const Teuchos::RCP< Objective< Real > > &  pObj,
const Real  order,
const Real  threshold,
const Teuchos::RCP< SampleGenerator< Real > > &  vsampler,
const Teuchos::RCP< SampleGenerator< Real > > &  gsampler,
const bool  storage = true 
)
inline

◆ BPOEObjective() [3/3]

template<class Real >
ROL::BPOEObjective< Real >::BPOEObjective ( const Teuchos::RCP< Objective< Real > > &  pObj,
const Real  order,
const Real  threshold,
const Teuchos::RCP< SampleGenerator< Real > > &  sampler,
const bool  storage = true 
)
inline

Member Function Documentation

◆ initialize()

template<class Real >
void ROL::BPOEObjective< Real >::initialize ( const Vector< Real > &  x)
inlineprivate

◆ unwrap_const_CVaR_vector()

template<class Real >
void ROL::BPOEObjective< Real >::unwrap_const_CVaR_vector ( Teuchos::RCP< Vector< Real > > &  xvec,
Real &  xvar,
const Vector< Real > &  x 
)
inlineprivate

◆ getValue()

template<class Real >
void ROL::BPOEObjective< Real >::getValue ( Real &  val,
const Vector< Real > &  x,
const std::vector< Real > &  param,
Real &  tol 
)
inlineprivate

◆ getGradient()

template<class Real >
void ROL::BPOEObjective< Real >::getGradient ( Vector< Real > &  g,
const Vector< Real > &  x,
const std::vector< Real > &  param,
Real &  tol 
)
inlineprivate

◆ getHessVec()

template<class Real >
void ROL::BPOEObjective< Real >::getHessVec ( Vector< Real > &  hv,
const Vector< Real > &  v,
const Vector< Real > &  x,
const std::vector< Real > &  param,
Real &  tol 
)
inlineprivate

◆ update()

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

Update objective function.

This function updates the objective function at new iterations.

Parameters
[in]xis the new iterate.
[in]flagis true if the iterate has changed.
[in]iteris the outer algorithm iterations count.

Reimplemented from ROL::Objective< Real >.

Definition at line 182 of file ROL_BPOEObjective.hpp.

References ROL::BPOEObjective< Real >::gradient_storage_, ROL::BPOEObjective< Real >::GradientSampler_, ROL::BPOEObjective< Real >::HessianSampler_, ROL::BPOEObjective< Real >::ParametrizedObjective_, ROL::BPOEObjective< Real >::storage_, ROL::BPOEObjective< Real >::unwrap_const_CVaR_vector(), ROL::BPOEObjective< Real >::value_storage_, and ROL::BPOEObjective< Real >::ValueSampler_.

◆ value()

template<class Real >
Real ROL::BPOEObjective< Real >::value ( const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Compute value.

This function returns the objective function value.

Parameters
[in]xis the current iterate.
[in]tolis a tolerance for inexact objective function computation.

Implements ROL::Objective< Real >.

Definition at line 199 of file ROL_BPOEObjective.hpp.

References ROL::BPOEObjective< Real >::getValue(), ROL::BPOEObjective< Real >::order_, ROL::BPOEObjective< Real >::threshold_, ROL::BPOEObjective< Real >::unwrap_const_CVaR_vector(), and ROL::BPOEObjective< Real >::ValueSampler_.

◆ gradient()

template<class Real >
void ROL::BPOEObjective< Real >::gradient ( Vector< Real > &  g,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Compute gradient.

This function returns the objective function gradient.

Parameters
[out]gis the gradient.
[in]xis the current iterate.
[in]tolis a tolerance for inexact objective function computation.

The default implementation is a finite-difference approximation based on the function value. This requires the definition of a basis \(\{\phi_i\}\) for the optimization vectors x and the definition of a basis \(\{\psi_j\}\) for the dual optimization vectors (gradient vectors g). The bases must be related through the Riesz map, i.e., \( R \{\phi_i\} = \{\psi_j\}\), and this must be reflected in the implementation of the ROL::Vector::dual() method.

Reimplemented from ROL::Objective< Real >.

Definition at line 224 of file ROL_BPOEObjective.hpp.

References ROL::BPOEObjective< Real >::getGradient(), ROL::BPOEObjective< Real >::getValue(), ROL::BPOEObjective< Real >::gradient0_, ROL::BPOEObjective< Real >::GradientSampler_, ROL::BPOEObjective< Real >::order_, ROL::BPOEObjective< Real >::pointGrad_, ROL::RiskVector< Real >::setStatistic(), ROL::RiskVector< Real >::setVector(), ROL::BPOEObjective< Real >::sumGrad0_, ROL::BPOEObjective< Real >::threshold_, ROL::BPOEObjective< Real >::unwrap_const_CVaR_vector(), and ROL::Vector< Real >::zero().

◆ hessVec()

template<class Real >
void ROL::BPOEObjective< Real >::hessVec ( Vector< Real > &  hv,
const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

◆ precond()

template<class Real >
virtual void ROL::BPOEObjective< Real >::precond ( Vector< Real > &  Pv,
const Vector< Real > &  v,
const Vector< Real > &  x,
Real &  tol 
)
inlinevirtual

Apply preconditioner to vector.

This function applies a preconditioner for the Hessian of the objective function to the vector \(v\).

Parameters
[out]Pvis the action of the Hessian preconditioner on \(v\).
[in]vis the direction vector.
[in]xis the current iterate.
[in]tolis a tolerance for inexact objective function computation.

Reimplemented from ROL::Objective< Real >.

Definition at line 350 of file ROL_BPOEObjective.hpp.

References ROL::Vector< Real >::dual(), and ROL::Vector< Real >::set().

Member Data Documentation

◆ ParametrizedObjective_

template<class Real >
Teuchos::RCP<Objective<Real> > ROL::BPOEObjective< Real >::ParametrizedObjective_
private

◆ order_

template<class Real >
Real ROL::BPOEObjective< Real >::order_
private

◆ threshold_

template<class Real >
Real ROL::BPOEObjective< Real >::threshold_
private

◆ ValueSampler_

template<class Real >
Teuchos::RCP<SampleGenerator<Real> > ROL::BPOEObjective< Real >::ValueSampler_
private

◆ GradientSampler_

template<class Real >
Teuchos::RCP<SampleGenerator<Real> > ROL::BPOEObjective< Real >::GradientSampler_
private

◆ HessianSampler_

template<class Real >
Teuchos::RCP<SampleGenerator<Real> > ROL::BPOEObjective< Real >::HessianSampler_
private

◆ pointGrad_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::pointGrad_
private

◆ pointHess_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::pointHess_
private

◆ gradient0_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::gradient0_
private

◆ sumGrad0_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::sumGrad0_
private

◆ gradient1_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::gradient1_
private

◆ sumGrad1_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::sumGrad1_
private

◆ gradient2_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::gradient2_
private

◆ sumGrad2_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::sumGrad2_
private

◆ hessvec_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::hessvec_
private

◆ sumHess_

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::BPOEObjective< Real >::sumHess_
private

◆ storage_

template<class Real >
bool ROL::BPOEObjective< Real >::storage_
private

◆ initialized_

template<class Real >
bool ROL::BPOEObjective< Real >::initialized_
private

◆ value_storage_

template<class Real >
std::map<std::vector<Real>,Real> ROL::BPOEObjective< Real >::value_storage_
private

◆ gradient_storage_

template<class Real >
std::map<std::vector<Real>,Teuchos::RCP<Vector<Real> > > ROL::BPOEObjective< Real >::gradient_storage_
private

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