ROL
Public Member Functions | Private Types | Private Member Functions | List of all members
ROL::ZOO::Objective_HS4< Real > Class Template Reference

W. Hock and K. Schittkowski 4th test function. More...

#include <ROL_HS4.hpp>

Inheritance diagram for ROL::ZOO::Objective_HS4< Real >:

Public Member Functions

 Objective_HS4 (void)
Real value (const Vector< Real > &x, Real &tol)
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
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 Types

typedef std::vector< Real > vector
typedef Vector< Real > V
typedef StdVector< Real > SV

Private Member Functions

ROL::Ptr< const vector > getVector (const V &x)
ROL::Ptr< vector > getVector (V &x)

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::ZOO::Objective_HS4< Real >

W. Hock and K. Schittkowski 4th test function.

Definition at line 33 of file ROL_HS4.hpp.

Member Typedef Documentation

◆ vector

template<class Real>
typedef std::vector<Real> ROL::ZOO::Objective_HS4< Real >::vector
private

Definition at line 35 of file ROL_HS4.hpp.

◆ V

template<class Real>
typedef Vector<Real> ROL::ZOO::Objective_HS4< Real >::V
private

Definition at line 36 of file ROL_HS4.hpp.

◆ SV

template<class Real>
typedef StdVector<Real> ROL::ZOO::Objective_HS4< Real >::SV
private

Definition at line 37 of file ROL_HS4.hpp.

Constructor & Destructor Documentation

◆ Objective_HS4()

template<class Real>
ROL::ZOO::Objective_HS4< Real >::Objective_HS4 ( void )
inline

Definition at line 52 of file ROL_HS4.hpp.

Member Function Documentation

◆ getVector() [1/2]

template<class Real>
ROL::Ptr< const vector > ROL::ZOO::Objective_HS4< Real >::getVector ( const V & x)
inlineprivate

Definition at line 41 of file ROL_HS4.hpp.

References getVector().

Referenced by getVector(), getVector(), gradient(), and value().

◆ getVector() [2/2]

template<class Real>
ROL::Ptr< vector > ROL::ZOO::Objective_HS4< Real >::getVector ( V & x)
inlineprivate

Definition at line 46 of file ROL_HS4.hpp.

References getVector().

◆ value()

template<class Real>
Real ROL::ZOO::Objective_HS4< Real >::value ( const Vector< Real > & x,
Real & tol )
inline

Definition at line 54 of file ROL_HS4.hpp.

References getVector().

◆ gradient()

template<class Real>
void ROL::ZOO::Objective_HS4< Real >::gradient ( Vector< Real > & g,
const Vector< Real > & x,
Real & tol )
inline

Definition at line 61 of file ROL_HS4.hpp.

References getVector().

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