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

This class strips out the slack variables from objective evaluations to create the new objective \( F(x,s) = f(x) \). More...

#include <ROL_SlacklessObjective.hpp>

Inheritance diagram for ROL::SlacklessObjective< Real >:

Public Member Functions

 ~SlacklessObjective ()
 SlacklessObjective (const Ptr< Objective< Real > > &obj)
Ptr< Objective< Real > > getObjective (void) const
void update (const Vector< Real > &x, UpdateType type, int iter=-1) override
void update (const Vector< Real > &x, bool flag=true, int iter=-1) override
Real value (const Vector< Real > &x, Real &tol) override
Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol) override
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol) override
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void invHessVec (Vector< Real > &ihv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void setParameter (const std::vector< Real > &param) 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.

Private Member Functions

Ptr< Vector< Real > > getOpt (Vector< Real > &xs) const
Ptr< const Vector< Real > > getOpt (const Vector< Real > &xs) const
void zeroSlack (Vector< Real > &x) const

Private Attributes

const Ptr< Objective< Real > > obj_

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

This class strips out the slack variables from objective evaluations to create the new objective \( F(x,s) = f(x) \).

Definition at line 25 of file ROL_SlacklessObjective.hpp.

Constructor & Destructor Documentation

◆ ~SlacklessObjective()

template<typename Real>
ROL::SlacklessObjective< Real >::~SlacklessObjective ( )
inline

Definition at line 30 of file ROL_SlacklessObjective.hpp.

◆ SlacklessObjective()

template<typename Real>
ROL::SlacklessObjective< Real >::SlacklessObjective ( const Ptr< Objective< Real > > & obj)

Definition at line 16 of file ROL_SlacklessObjective_Def.hpp.

References obj_, and ROL::ROL::Objective< Real >::Objective().

Member Function Documentation

◆ getObjective()

template<typename Real>
Ptr< Objective< Real > > ROL::SlacklessObjective< Real >::getObjective ( void ) const

Definition at line 19 of file ROL_SlacklessObjective_Def.hpp.

References obj_.

◆ update() [1/2]

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

Definition at line 24 of file ROL_SlacklessObjective_Def.hpp.

References getOpt(), and obj_.

◆ update() [2/2]

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

Definition at line 29 of file ROL_SlacklessObjective_Def.hpp.

References getOpt(), and obj_.

◆ value()

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

Definition at line 34 of file ROL_SlacklessObjective_Def.hpp.

References getOpt(), and obj_.

◆ dirDeriv()

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

Definition at line 39 of file ROL_SlacklessObjective_Def.hpp.

References getOpt(), and obj_.

◆ gradient()

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

Definition at line 44 of file ROL_SlacklessObjective_Def.hpp.

References getOpt(), obj_, and zeroSlack().

◆ hessVec()

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

Definition at line 50 of file ROL_SlacklessObjective_Def.hpp.

References getOpt(), obj_, and zeroSlack().

◆ invHessVec()

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

Definition at line 56 of file ROL_SlacklessObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), getOpt(), ROL::PartitionedVector< Real >::numVectors(), and obj_.

◆ precond()

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

Definition at line 67 of file ROL_SlacklessObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), getOpt(), ROL::PartitionedVector< Real >::numVectors(), and obj_.

◆ setParameter()

template<typename Real>
void ROL::SlacklessObjective< Real >::setParameter ( const std::vector< Real > & param)
overridevirtual

Reimplemented from ROL::ROL::Objective< Real >.

Definition at line 78 of file ROL_SlacklessObjective_Def.hpp.

References obj_, and ROL::Objective< Real >::setParameter().

◆ getOpt() [1/2]

template<typename Real>
Ptr< Vector< Real > > ROL::SlacklessObjective< Real >::getOpt ( Vector< Real > & xs) const
private

Definition at line 84 of file ROL_SlacklessObjective_Def.hpp.

Referenced by dirDeriv(), gradient(), hessVec(), invHessVec(), precond(), update(), update(), and value().

◆ getOpt() [2/2]

template<typename Real>
Ptr< const Vector< Real > > ROL::SlacklessObjective< Real >::getOpt ( const Vector< Real > & xs) const
private

Definition at line 89 of file ROL_SlacklessObjective_Def.hpp.

◆ zeroSlack()

template<typename Real>
void ROL::SlacklessObjective< Real >::zeroSlack ( Vector< Real > & x) const
private

Definition at line 94 of file ROL_SlacklessObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), and ROL::PartitionedVector< Real >::numVectors().

Referenced by gradient(), and hessVec().

Member Data Documentation

◆ obj_

template<typename Real>
const Ptr<Objective<Real> > ROL::SlacklessObjective< Real >::obj_
private

Definition at line 27 of file ROL_SlacklessObjective.hpp.

Referenced by dirDeriv(), getObjective(), gradient(), hessVec(), invHessVec(), precond(), setParameter(), SlacklessObjective(), update(), update(), and value().

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