ROL
Public Member Functions | Private Member Functions | List of all members
ROL::StdObjective< Real > Class Template Referenceabstract
User Interface » Functional Interface

Specializes the ROL::Objective interface for objective functions that operate on ROL::StdVector's. More...

#include <ROL_StdObjective.hpp>

Inheritance diagram for ROL::StdObjective< Real >:

Public Member Functions

virtual void update (const std::vector< Real > &x, bool flag=true, int iter=-1)
void update (const Vector< Real > &x, bool flag=true, int iter=-1) override
virtual void update (const std::vector< Real > &x, UpdateType type, int iter=-1)
void update (const Vector< Real > &x, UpdateType type, int iter=-1) override
virtual Real value (const std::vector< Real > &x, Real &tol)=0
Real value (const Vector< Real > &x, Real &tol) override
virtual void gradient (std::vector< Real > &g, const std::vector< Real > &x, Real &tol)
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol) override
virtual Real dirDeriv (const std::vector< Real > &x, const std::vector< Real > &d, Real &tol)
Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol) override
virtual void hessVec (std::vector< Real > &hv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
virtual void invHessVec (std::vector< Real > &hv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
virtual void precond (std::vector< Real > &Pv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
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)

Private Member Functions

Real sgn (Real x) const

Additional Inherited Members

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

Detailed Description

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

Specializes the ROL::Objective interface for objective functions that operate on ROL::StdVector's.

Definition at line 26 of file ROL_StdObjective.hpp.

Member Function Documentation

◆ update() [1/4]

template<typename Real>
virtual void ROL::StdObjective< Real >::update ( const std::vector< Real > & x,
bool flag = true,
int iter = -1 )
inlinevirtual

Definition at line 28 of file ROL_StdObjective.hpp.

◆ update() [2/4]

template<typename Real>
void ROL::StdObjective< Real >::update ( const Vector< Real > & x,
bool flag = true,
int iter = -1 )
override

Definition at line 16 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and update().

◆ update() [3/4]

template<typename Real>
virtual void ROL::StdObjective< Real >::update ( const std::vector< Real > & x,
UpdateType type,
int iter = -1 )
inlinevirtual

Definition at line 33 of file ROL_StdObjective.hpp.

◆ update() [4/4]

template<typename Real>
void ROL::StdObjective< Real >::update ( const Vector< Real > & x,
UpdateType type,
int iter = -1 )
override

Definition at line 22 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and update().

◆ value() [1/2]

template<typename Real>
virtual Real ROL::StdObjective< Real >::value ( const std::vector< Real > & x,
Real & tol )
pure virtual

Implemented in ObjectiveFunctionTest06< Real >, ObjectiveFunctionTest07_1< Real >, ObjectiveFunctionTest07_2< Real >, ObjectiveFunctionTest07_scalarize< Real >, ObjectiveFunctionTest08_scalarize< Real >, ROL::RegressionError< Real >, ROL::ZOO::Objective_Cantilever< Real >, ROL::ZOO::Objective_CantileverBeam< Real >, ROL::ZOO::Objective_Cubic< Real >, ROL::ZOO::Objective_CylinderHead< Real >, ROL::ZOO::Objective_HS14< Real >, ROL::ZOO::Objective_HS21< Real >, ROL::ZOO::Objective_HS28< Real >, ROL::ZOO::Objective_HS41< Real >, ROL::ZOO::Objective_HS42< Real >, ROL::ZOO::Objective_HS48< Real >, ROL::ZOO::Objective_HS49< Real >, ROL::ZOO::Objective_HS50< Real >, ROL::ZOO::Objective_HS51< Real >, ROL::ZOO::Objective_HS52< Real >, ROL::ZOO::Objective_HS53< Real >, ROL::ZOO::Objective_HS55< Real >, ROL::ZOO::Objective_HS63< Real >, ROL::ZOO::Objective_HS9< Real >, and ROL::ZOO::Objective_Quartic< Real >.

References dirDeriv(), gradient(), hessVec(), invHessVec(), ROL::ROL::Objective< Real >::Objective(), precond(), and value().

Referenced by value().

◆ value() [2/2]

template<typename Real>
Real ROL::StdObjective< Real >::value ( const Vector< Real > & x,
Real & tol )
override

Definition at line 28 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and ROL::value().

◆ gradient() [1/2]

template<typename Real>
void ROL::StdObjective< Real >::gradient ( std::vector< Real > & g,
const std::vector< Real > & x,
Real & tol )
virtual

Reimplemented in ObjectiveFunctionTest06< Real >, ObjectiveFunctionTest07_1< Real >, ObjectiveFunctionTest07_2< Real >, ObjectiveFunctionTest07_scalarize< Real >, ObjectiveFunctionTest08_scalarize< Real >, ROL::RegressionError< Real >, ROL::ZOO::Objective_Cantilever< Real >, ROL::ZOO::Objective_CantileverBeam< Real >, ROL::ZOO::Objective_Cubic< Real >, ROL::ZOO::Objective_CylinderHead< Real >, ROL::ZOO::Objective_HS14< Real >, ROL::ZOO::Objective_HS21< Real >, ROL::ZOO::Objective_HS28< Real >, ROL::ZOO::Objective_HS41< Real >, ROL::ZOO::Objective_HS42< Real >, ROL::ZOO::Objective_HS48< Real >, ROL::ZOO::Objective_HS49< Real >, ROL::ZOO::Objective_HS50< Real >, ROL::ZOO::Objective_HS51< Real >, ROL::ZOO::Objective_HS52< Real >, ROL::ZOO::Objective_HS53< Real >, ROL::ZOO::Objective_HS55< Real >, ROL::ZOO::Objective_HS63< Real >, ROL::ZOO::Objective_HS9< Real >, and ROL::ZOO::Objective_Quartic< Real >.

Definition at line 34 of file ROL_StdObjective_Def.hpp.

References ROL::ROL::ROL_EPSILON(), sgn(), update(), and ROL::value().

Referenced by gradient(), and value().

◆ gradient() [2/2]

template<typename Real>
void ROL::StdObjective< Real >::gradient ( Vector< Real > & g,
const Vector< Real > & x,
Real & tol )
override

Definition at line 53 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and gradient().

◆ dirDeriv() [1/2]

template<typename Real>
Real ROL::StdObjective< Real >::dirDeriv ( const std::vector< Real > & x,
const std::vector< Real > & d,
Real & tol )
virtual

Definition at line 60 of file ROL_StdObjective_Def.hpp.

Referenced by dirDeriv(), and value().

◆ dirDeriv() [2/2]

template<typename Real>
Real ROL::StdObjective< Real >::dirDeriv ( const Vector< Real > & x,
const Vector< Real > & d,
Real & tol )
override

Definition at line 66 of file ROL_StdObjective_Def.hpp.

References ROL::Objective< Real >::dirDeriv(), dirDeriv(), and ROL::StdVector< Real, Element >::getVector().

◆ hessVec() [1/2]

template<typename Real>
void ROL::StdObjective< Real >::hessVec ( std::vector< Real > & hv,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
virtual

Reimplemented in ObjectiveFunctionTest06< Real >, ObjectiveFunctionTest07_1< Real >, ObjectiveFunctionTest07_2< Real >, ObjectiveFunctionTest07_scalarize< Real >, ObjectiveFunctionTest08_scalarize< Real >, ROL::RegressionError< Real >, ROL::ZOO::Objective_CantileverBeam< Real >, ROL::ZOO::Objective_HS14< Real >, ROL::ZOO::Objective_HS21< Real >, ROL::ZOO::Objective_HS28< Real >, ROL::ZOO::Objective_HS41< Real >, ROL::ZOO::Objective_HS42< Real >, ROL::ZOO::Objective_HS48< Real >, ROL::ZOO::Objective_HS49< Real >, ROL::ZOO::Objective_HS50< Real >, ROL::ZOO::Objective_HS51< Real >, ROL::ZOO::Objective_HS52< Real >, ROL::ZOO::Objective_HS53< Real >, ROL::ZOO::Objective_HS55< Real >, ROL::ZOO::Objective_HS63< Real >, and ROL::ZOO::Objective_HS9< Real >.

Definition at line 78 of file ROL_StdObjective_Def.hpp.

Referenced by hessVec(), and value().

◆ hessVec() [2/2]

template<typename Real>
void ROL::StdObjective< Real >::hessVec ( Vector< Real > & hv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 84 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), ROL::Objective< Real >::hessVec(), and hessVec().

◆ invHessVec() [1/2]

template<typename Real>
void ROL::StdObjective< Real >::invHessVec ( std::vector< Real > & hv,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
virtual

Reimplemented in ROL::ZOO::Objective_Cubic< Real >.

Definition at line 97 of file ROL_StdObjective_Def.hpp.

Referenced by invHessVec(), and value().

◆ invHessVec() [2/2]

template<typename Real>
void ROL::StdObjective< Real >::invHessVec ( Vector< Real > & hv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 103 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and invHessVec().

◆ precond() [1/2]

template<typename Real>
void ROL::StdObjective< Real >::precond ( std::vector< Real > & Pv,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
virtual

Definition at line 111 of file ROL_StdObjective_Def.hpp.

Referenced by precond(), and value().

◆ precond() [2/2]

template<typename Real>
void ROL::StdObjective< Real >::precond ( Vector< Real > & Pv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 116 of file ROL_StdObjective_Def.hpp.

References ROL::StdVector< Real, Element >::getVector(), and precond().

◆ sgn()

template<typename Real>
Real ROL::StdObjective< Real >::sgn ( Real x) const
private

Definition at line 124 of file ROL_StdObjective_Def.hpp.

References zero.

Referenced by gradient().

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0