ROL
ROL::TypeBIndicatorObjective< Real > Class Template Reference

Provides the interface to evaluate the indicator function of linear constraints. More...

#include <ROL_TypeBIndicatorObjective.hpp>

Inheritance diagram for ROL::TypeBIndicatorObjective< Real >:

Public Member Functions

 TypeBIndicatorObjective (const Ptr< BoundConstraint< Real > > &bnd)
 TypeBIndicatorObjective (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res, ParameterList &list) proj_(PolyhedralProjectionFactory< Real >(xprim
 res_ (res.clone())
 TypeBIndicatorObjective (const Ptr< PolyhedralProjection< Real > > &proj)
Real value (const Vector< Real > &x, Real &tol)
void prox (Vector< Real > &Pv, const Vector< Real > &v, Real t, 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)
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)

Public Attributes

 xdual
 bnd
 con
 mul
 res
 list

Private Attributes

const Ptr< PolyhedralProjection< Real > > proj_
const Ptr< Vector< Real > > res_

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::TypeBIndicatorObjective< Real >

Provides the interface to evaluate the indicator function of linear constraints.


Definition at line 61 of file ROL_TypeBIndicatorObjective.hpp.

Constructor & Destructor Documentation

◆ TypeBIndicatorObjective() [1/3]

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::TypeBIndicatorObjective ( const Ptr< BoundConstraint< Real > > & bnd)
inline

Definition at line 68 of file ROL_TypeBIndicatorObjective.hpp.

References bnd, and proj_.

◆ TypeBIndicatorObjective() [2/3]

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::TypeBIndicatorObjective ( const Vector< Real > & xprim,
const Vector< Real > & xdual,
const Ptr< BoundConstraint< Real > > & bnd,
const Ptr< Constraint< Real > > & con,
const Vector< Real > & mul,
const Vector< Real > & res,
ParameterList & list )

References bnd, con, list, mul, res, and xdual.

◆ TypeBIndicatorObjective() [3/3]

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::TypeBIndicatorObjective ( const Ptr< PolyhedralProjection< Real > > & proj)
inline

Definition at line 81 of file ROL_TypeBIndicatorObjective.hpp.

References proj_, and res_.

Member Function Documentation

◆ res_()

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::res_ ( res. clone())
inline

Definition at line 79 of file ROL_TypeBIndicatorObjective.hpp.

References res, and res_.

◆ value()

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

Definition at line 84 of file ROL_TypeBIndicatorObjective.hpp.

References proj_, res_, ROL::ROL_EPSILON(), ROL::ROL_INF(), and zero.

◆ prox()

template<typename Real>
void ROL::TypeBIndicatorObjective< Real >::prox ( Vector< Real > & Pv,
const Vector< Real > & v,
Real t,
Real & tol )
inline

Definition at line 96 of file ROL_TypeBIndicatorObjective.hpp.

References proj_, and ROL::Vector< Real >::set().

Member Data Documentation

◆ proj_

template<typename Real>
const Ptr<PolyhedralProjection<Real> > ROL::TypeBIndicatorObjective< Real >::proj_
private

◆ res_

template<typename Real>
const Ptr<Vector<Real> > ROL::TypeBIndicatorObjective< Real >::res_
private

Definition at line 64 of file ROL_TypeBIndicatorObjective.hpp.

Referenced by res_(), TypeBIndicatorObjective(), and value().

◆ xdual

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::xdual

Definition at line 78 of file ROL_TypeBIndicatorObjective.hpp.

Referenced by TypeBIndicatorObjective().

◆ bnd

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::bnd

◆ con

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::con

Definition at line 78 of file ROL_TypeBIndicatorObjective.hpp.

Referenced by TypeBIndicatorObjective().

◆ mul

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::mul

Definition at line 78 of file ROL_TypeBIndicatorObjective.hpp.

Referenced by TypeBIndicatorObjective().

◆ res

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::res

Definition at line 78 of file ROL_TypeBIndicatorObjective.hpp.

Referenced by res_(), and TypeBIndicatorObjective().

◆ list

template<typename Real>
ROL::TypeBIndicatorObjective< Real >::list

Definition at line 78 of file ROL_TypeBIndicatorObjective.hpp.

Referenced by TypeBIndicatorObjective().


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