Provides the interface to evaluate the indicator function of norm constraints. More...
#include <ROL_BallIndicatorObjective.hpp>
Inheritance diagram for ROL::BallIndicatorObjective< Real >:
Public Member Functions | |
| BallIndicatorObjective (const Ptr< Vector< Real >> &x, Real rad) | |
| Real | value (const Vector< Real > &x, Real &tol) |
| Compute value. More... | |
| void | prox (Vector< Real > &Pv, const Vector< Real > &v, Real t, Real &tol) |
| Public Member Functions inherited from ROL::Objective< Real > | |
| virtual | ~Objective () |
| Objective () | |
| virtual void | update (const Vector< Real > &x, UpdateType type, int iter=-1) |
| Update objective function. More... | |
| virtual void | update (const Vector< Real > &x, bool flag=true, int iter=-1) |
| Update objective function. More... | |
| virtual void | gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol) |
| Compute gradient. More... | |
| virtual Real | dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol) |
| Compute directional derivative. More... | |
| virtual void | hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) |
| Apply Hessian approximation to vector. More... | |
| virtual void | invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) |
| Apply inverse Hessian approximation to vector. More... | |
| virtual void | precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) |
| Apply preconditioner to vector. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | setParameter (const std::vector< Real > ¶m) |
Private Attributes | |
| const Ptr< Vector< Real > > | x_ |
| const Ptr< Vector< Real > > | pwa_ |
| const Real | rad_ |
Additional Inherited Members | |
| Protected Member Functions inherited from ROL::Objective< Real > | |
| const std::vector< Real > | getParameter (void) const |
Detailed Description
template<typename Real>
class ROL::BallIndicatorObjective< Real >
Provides the interface to evaluate the indicator function of norm constraints.
Definition at line 26 of file ROL_BallIndicatorObjective.hpp.
Constructor & Destructor Documentation
|
inline |
Definition at line 33 of file ROL_BallIndicatorObjective.hpp.
Member Function Documentation
|
inlinevirtual |
Compute value.
This function returns the objective function value.
- Parameters
-
[in] x is the current iterate. [in] tol is a tolerance for inexact objective function computation.
Implements ROL::Objective< Real >.
Definition at line 36 of file ROL_BallIndicatorObjective.hpp.
References ROL::BallIndicatorObjective< Real >::pwa_, ROL::BallIndicatorObjective< Real >::rad_, ROL::BallIndicatorObjective< Real >::x_, and zero.
|
inlinevirtual |
Reimplemented from ROL::Objective< Real >.
Definition at line 43 of file ROL_BallIndicatorObjective.hpp.
References ROL::Vector< Real >::axpy(), ROL::BallIndicatorObjective< Real >::pwa_, ROL::BallIndicatorObjective< Real >::rad_, ROL::Vector< Real >::set(), and ROL::BallIndicatorObjective< Real >::x_.
Member Data Documentation
|
private |
Definition at line 28 of file ROL_BallIndicatorObjective.hpp.
Referenced by ROL::BallIndicatorObjective< Real >::prox(), and ROL::BallIndicatorObjective< Real >::value().
|
private |
Definition at line 28 of file ROL_BallIndicatorObjective.hpp.
Referenced by ROL::BallIndicatorObjective< Real >::prox(), and ROL::BallIndicatorObjective< Real >::value().
|
private |
Definition at line 29 of file ROL_BallIndicatorObjective.hpp.
Referenced by ROL::BallIndicatorObjective< Real >::prox(), and ROL::BallIndicatorObjective< Real >::value().
The documentation for this class was generated from the following file:
