ROL
ROL::CompositeObjective_SimOpt< Real > Class Template Reference

Provides the interface to evaluate simulation-based composite objective functions. More...

#include <ROL_CompositeObjective_SimOpt.hpp>

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

Public Member Functions

 CompositeObjective_SimOpt (const std::vector< ROL::Ptr< Objective_SimOpt< Real > > > &obj_vec, const ROL::Ptr< StdObjective< Real > > &std_obj)
 
void update (const Vector< Real > &u, const Vector< Real > &z, bool flag=true, int iter=-1)
 Update objective function.
u is an iterate, z is an iterate, flag = true if the iterate has changed, iter is the outer algorithm iterations count.
 
void update (const Vector< Real > &u, const Vector< Real > &z, UpdateType type, int iter=-1)
 
Real value (const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 Compute value.
 
void gradient_1 (Vector< Real > &g, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 Compute gradient with respect to first component.
 
void gradient_2 (Vector< Real > &g, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 Compute gradient with respect to second component.
 
void hessVec_11 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 Apply Hessian approximation to vector.
 
void hessVec_12 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void hessVec_21 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void hessVec_22 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void setParameter (const std::vector< Real > &param)
 
- Public Member Functions inherited from ROL::Objective_SimOpt< Real >
void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 
void update (const Vector< Real > &x, UpdateType type, int iter=-1)
 
Real value (const Vector< Real > &x, Real &tol)
 
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
 
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 
std::vector< std::vector< Real > > checkGradient_1 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 
std::vector< std::vector< Real > > checkGradient_1 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
 
std::vector< std::vector< Real > > checkGradient_1 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
 
std::vector< std::vector< Real > > checkGradient_2 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 
std::vector< std::vector< Real > > checkGradient_2 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
 
std::vector< std::vector< Real > > checkGradient_2 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
 
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
 
std::vector< std::vector< Real > > checkHessVec_11 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
 
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
 
std::vector< std::vector< Real > > checkHessVec_12 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
 
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
 
std::vector< std::vector< Real > > checkHessVec_21 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
 
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream, std::ostream &outStream, const int numSteps, const int order)
 
std::vector< std::vector< Real > > checkHessVec_22 (const Vector< Real > &u, const Vector< Real > &z, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream, std::ostream &outStream, const int order)
 
- Public Member Functions inherited from ROL::ROL::Objective< Real >
virtual ~Objective ()
 
 Objective ()
 
virtual void update (const Vector< Real > &x, UpdateType type, int iter=-1)
 Update objective function.
 
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update objective function.
 
virtual Real value (const Vector< Real > &x, Real &tol)=0
 Compute value.
 
virtual void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
 Compute gradient.
 
virtual Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
 Compute directional derivative.
 
virtual void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply Hessian approximation to vector.
 
virtual void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply inverse Hessian approximation to vector.
 
virtual void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply preconditioner to vector.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 

Private Member Functions

void initialize (const Vector< Real > &u, const Vector< Real > &z)
 
void computeValue (const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeGradient (const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeGradient1 (const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeGradient2 (const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeHessVec11 (const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeHessVec12 (const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeHessVec21 (const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 
void computeHessVec22 (const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
 

Private Attributes

const std::vector< ROL::Ptr< Objective_SimOpt< Real > > > obj_vec_
 
const ROL::Ptr< StdObjective< Real > > std_obj_
 
ROL::Ptr< std::vector< Real > > obj_value_
 
ROL::Ptr< std::vector< Real > > obj_grad_
 
ROL::Ptr< std::vector< Real > > obj_gv_
 
ROL::Ptr< std::vector< Real > > obj_hess_
 
ROL::Ptr< StdVector< Real > > obj_value_vec_
 
ROL::Ptr< StdVector< Real > > obj_grad_vec_
 
ROL::Ptr< StdVector< Real > > obj_gv_vec_
 
ROL::Ptr< StdVector< Real > > obj_hess_vec_
 
std::vector< ROL::Ptr< Vector< Real > > > vec_grad1_
 
std::vector< ROL::Ptr< Vector< Real > > > vec_grad2_
 
std::vector< ROL::Ptr< Vector< Real > > > vec_hess1_
 
std::vector< ROL::Ptr< Vector< Real > > > vec_hess2_
 
bool isInitialized_
 
bool isValueComputed_
 
bool isGradientComputed_
 
bool isGradient1Computed_
 
bool isGradient2Computed_
 

Additional Inherited Members

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

Detailed Description

template<class Real>
class ROL::CompositeObjective_SimOpt< Real >

Provides the interface to evaluate simulation-based composite objective functions.

Definition at line 59 of file ROL_CompositeObjective_SimOpt.hpp.

Constructor & Destructor Documentation

◆ CompositeObjective_SimOpt()

Member Function Documentation

◆ initialize()

◆ computeValue()

◆ computeGradient()

◆ computeGradient1()

◆ computeGradient2()

◆ computeHessVec11()

◆ computeHessVec12()

◆ computeHessVec21()

◆ computeHessVec22()

◆ update() [1/2]

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

◆ update() [2/2]

◆ value()

template<class Real >
Real ROL::CompositeObjective_SimOpt< Real >::value ( const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlinevirtual

◆ gradient_1()

template<class Real >
void ROL::CompositeObjective_SimOpt< Real >::gradient_1 ( Vector< Real > & g,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlinevirtual

◆ gradient_2()

template<class Real >
void ROL::CompositeObjective_SimOpt< Real >::gradient_2 ( Vector< Real > & g,
const Vector< Real > & u,
const Vector< Real > & z,
Real & tol )
inlinevirtual

◆ hessVec_11()

◆ hessVec_12()

◆ hessVec_21()

◆ hessVec_22()

◆ setParameter()

Member Data Documentation

◆ obj_vec_

◆ std_obj_

◆ obj_value_

template<class Real >
ROL::Ptr<std::vector<Real> > ROL::CompositeObjective_SimOpt< Real >::obj_value_
private

◆ obj_grad_

◆ obj_gv_

template<class Real >
ROL::Ptr<std::vector<Real> > ROL::CompositeObjective_SimOpt< Real >::obj_gv_
private

◆ obj_hess_

◆ obj_value_vec_

◆ obj_grad_vec_

◆ obj_gv_vec_

◆ obj_hess_vec_

◆ vec_grad1_

◆ vec_grad2_

◆ vec_hess1_

◆ vec_hess2_

◆ isInitialized_

template<class Real >
bool ROL::CompositeObjective_SimOpt< Real >::isInitialized_
private

◆ isValueComputed_

◆ isGradientComputed_

◆ isGradient1Computed_

◆ isGradient2Computed_


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