ROL::Objective_SerialSimOpt< Real > Class Template Reference

#include <ROL_Objective_SerialSimOpt.hpp>

Inheritance diagram for ROL::Objective_SerialSimOpt< Real >:

Public Attributes
Objective_SerialSimOpt(const Ptr< Obj > &obj, const V &ui) z0	zero )()

Protected Member Functions
PV &	partition (V &x) const
const PV &	partition (const V &x) const
Protected Member Functions inherited from ROL::ROL::Objective< Real >
const std::vector< Real >	getParameter (void) const

Private Types
using	V = Vector<Real>
using	PV = PartitionedVector<Real>
using	Obj = Objective_TimeSimOpt<Real>
using	size_type = typename PV<Real>::size_type

Private Attributes
const Ptr< Obj >	obj_
const Ptr< V >	ui_
VectorWorkspace< Real >	workspace_

Additional Inherited Members
Public Member Functions inherited from ROL::Objective_SimOpt< Real >
virtual 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 > &x, bool flag=true, int iter=-1)
virtual void	update (const Vector< Real > &u, const Vector< Real > &z, UpdateType type, int iter=-1)
void	update (const Vector< Real > &x, UpdateType type, int iter=-1)
virtual Real	value (const Vector< Real > &u, const Vector< Real > &z, Real &tol)=0
	Compute value.
Real	value (const Vector< Real > &x, Real &tol)
virtual void	gradient_1 (Vector< Real > &g, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Compute gradient with respect to first component.
virtual void	gradient_2 (Vector< Real > &g, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
	Compute gradient with respect to second component.
void	gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
virtual 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.
virtual void	hessVec_12 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
virtual void	hessVec_21 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, Real &tol)
virtual void	hessVec_22 (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &u, const Vector< Real > &z, 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 void	prox (Vector< Real > &Pv, const Vector< Real > &v, Real t, Real &tol)
	Compute the proximity operator.
virtual void	proxJacVec (Vector< Real > &Jv, const Vector< Real > &v, const Vector< Real > &x, Real t, Real &tol)
	Apply the Jacobian of the proximity operator.
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.
virtual std::vector< std::vector< Real > >	checkProxJacVec (const Vector< Real > &x, const Vector< Real > &v, Real t=Real(1), bool printToStream=true, std::ostream &outStream=std::cout, int numSteps=ROL_NUM_CHECKDERIV_STEPS)
	Finite-difference proximity operator Jacobian-applied-to-vector check.
virtual void	setParameter (const std::vector< Real > &param)

Detailed Description

template<typename Real>
class ROL::Objective_SerialSimOpt< Real >

Definition at line 19 of file ROL_Objective_SerialSimOpt.hpp.

Member Typedef Documentation

V

template<typename Real>

using ROL::Objective_SerialSimOpt< Real >::V = Vector<Real>

private

Definition at line 21 of file ROL_Objective_SerialSimOpt.hpp.

PV

template<typename Real>

using ROL::Objective_SerialSimOpt< Real >::PV = PartitionedVector<Real>

private

Definition at line 22 of file ROL_Objective_SerialSimOpt.hpp.

Obj

template<typename Real>

using ROL::Objective_SerialSimOpt< Real >::Obj = Objective_TimeSimOpt<Real>

private

Definition at line 23 of file ROL_Objective_SerialSimOpt.hpp.

size_type

template<typename Real>

using ROL::Objective_SerialSimOpt< Real >::size_type = typename PV<Real>::size_type

private

Definition at line 25 of file ROL_Objective_SerialSimOpt.hpp.

Member Function Documentation

partition() [1/2]

template<typename Real>

PV & ROL::Objective_SerialSimOpt< Real >::partition ( V & x ) const

inlineprotected

Definition at line 37 of file ROL_Objective_SerialSimOpt.hpp.

partition() [2/2]

template<typename Real>

const PV & ROL::Objective_SerialSimOpt< Real >::partition ( const V & x ) const

inlineprotected

Definition at line 39 of file ROL_Objective_SerialSimOpt.hpp.

Member Data Documentation

obj_

template<typename Real>

const Ptr<Obj> ROL::Objective_SerialSimOpt< Real >::obj_

private

Definition at line 29 of file ROL_Objective_SerialSimOpt.hpp.

ui_

template<typename Real>

const Ptr<V> ROL::Objective_SerialSimOpt< Real >::ui_

private

Definition at line 30 of file ROL_Objective_SerialSimOpt.hpp.

workspace_

template<typename Real>

VectorWorkspace<Real> ROL::Objective_SerialSimOpt< Real >::workspace_

private

Definition at line 32 of file ROL_Objective_SerialSimOpt.hpp.

zero

template<typename Real>

Objective_SerialSimOpt(const Ptr< Obj > &obj, const V &ui) z0 ROL::Objective_SerialSimOpt< Real >::zero) ()

Definition at line 46 of file ROL_Objective_SerialSimOpt.hpp.

---

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

• ROL_Objective_SerialSimOpt.hpp