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

#include <ROL_HS21.hpp>

+ Inheritance diagram for ROL::ZOO::Objective_HS21< Real >:

Public Member Functions

Real value (const std::vector< Real > &x, Real &tol)
 
void gradient (std::vector< Real > &g, const std::vector< Real > &x, Real &tol)
 
void hessVec (std::vector< Real > &hv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
 
- Public Member Functions inherited from ROL::StdObjective< Real >
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
 Update objective function.
 
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
 Update objective function.
 
Real value (const Vector< Real > &x, Real &tol) override
 Compute value.
 
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol) override
 Compute gradient.
 
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
 Compute directional derivative.
 
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
 Apply Hessian approximation to vector.
 
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
 Apply inverse Hessian approximation to vector.
 
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
 Apply preconditioner to vector.
 
- Public Member Functions inherited from ROL::Objective< Real >
virtual ~Objective ()
 
 Objective ()
 
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 void setParameter (const std::vector< Real > &param)
 

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

Definition at line 62 of file ROL_HS21.hpp.

Member Function Documentation

◆ value()

template<class Real >
Real ROL::ZOO::Objective_HS21< Real >::value ( const std::vector< Real > & x,
Real & tol )
inlinevirtual

Implements ROL::StdObjective< Real >.

Definition at line 64 of file ROL_HS21.hpp.

◆ gradient()

template<class Real >
void ROL::ZOO::Objective_HS21< Real >::gradient ( std::vector< Real > & g,
const std::vector< Real > & x,
Real & tol )
inlinevirtual

Reimplemented from ROL::StdObjective< Real >.

Definition at line 69 of file ROL_HS21.hpp.

◆ hessVec()

template<class Real >
void ROL::ZOO::Objective_HS21< Real >::hessVec ( std::vector< Real > & hv,
const std::vector< Real > & v,
const std::vector< Real > & x,
Real & tol )
inlinevirtual

Reimplemented from ROL::StdObjective< Real >.

Definition at line 75 of file ROL_HS21.hpp.


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