#include <ROL_InteriorPoint.hpp>

Inheritance diagram for ROL::InteriorPoint::PenalizedObjective< Real >:

Public Member Functions
	PenalizedObjective (const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< BoundConstraint< Real > > &bnd, const Vector< Real > &x, ROL::ParameterList &parlist)

void	updatePenalty (Real mu)

int	getNumberFunctionEvaluations (void)

int	getNumberGradientEvaluations (void)

void	reset (void)

void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update objective function. More...

Real	value (const Vector< Real > &x, Real &tol)
	Compute value. More...

Real	getObjectiveValue (void)

void	gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
	Compute gradient. More...

void	getObjectiveGradient (Vector< Real > &g)

Real	getGradientNorm ()

void	hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply Hessian approximation to vector. More...

Public Member Functions inherited from ROL::Objective< Real >
virtual	~Objective ()

virtual Real	dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
	Compute directional derivative. 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 > &param)

Private Types
typedef PartitionedVector < Real >::size_type	size_type

Private Attributes
ROL::Ptr< Objective< Real > >	obj_

ROL::Ptr< Objective< Real > >	barrier_

ROL::Ptr< Vector< Real > >	x_

ROL::Ptr< Vector< Real > >	g_

ROL::Ptr< Vector< Real > >	scratch_

Real	mu_

Real	fval_

Real	gnorm_

int	nfval_

int	ngval_

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::InteriorPoint::PenalizedObjective< Real >

Definition at line 57 of file ROL_InteriorPoint.hpp.

Member Typedef Documentation

template<class Real >

typedef PartitionedVector<Real>::size_type ROL::InteriorPoint::PenalizedObjective< Real >::size_type

private

Definition at line 59 of file ROL_InteriorPoint.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::InteriorPoint::PenalizedObjective< Real >::PenalizedObjective	(	const ROL::Ptr< Objective< Real > > &	obj,
		const ROL::Ptr< BoundConstraint< Real > > &	bnd,
		const Vector< Real > &	x,
		ROL::ParameterList &	parlist
	)

inline

Definition at line 75 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::barrier_, ROL::Vector< Real >::clone(), ROL::Vector< Real >::dual(), ROL::InteriorPoint::PenalizedObjective< Real >::g_, ROL::InteriorPoint::PenalizedObjective< Real >::mu_, ROL::InteriorPoint::PenalizedObjective< Real >::scratch_, and ROL::InteriorPoint::PenalizedObjective< Real >::x_.

Member Function Documentation

template<class Real >

void ROL::InteriorPoint::PenalizedObjective< Real >::updatePenalty ( Real mu )

inline

Definition at line 89 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::mu_.

Referenced by ROL::InteriorPointStep< Real >::initialize().

template<class Real >

int ROL::InteriorPoint::PenalizedObjective< Real >::getNumberFunctionEvaluations ( void )

inline

Definition at line 93 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::nfval_.

template<class Real >

int ROL::InteriorPoint::PenalizedObjective< Real >::getNumberGradientEvaluations ( void )

inline

Definition at line 97 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::ngval_.

template<class Real >

void ROL::InteriorPoint::PenalizedObjective< Real >::reset ( void )

inline

Definition at line 101 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::nfval_.

template<class Real >

void ROL::InteriorPoint::PenalizedObjective< Real >::update	(	const Vector< Real > &	x,
		bool	flag = `true`,
		int	iter = `-1`
	)

inlinevirtual

Update objective function.

This function updates the objective function at new iterations.

Parameters

[in]	x	is the new iterate.
[in]	flag	is true if the iterate has changed.
[in]	iter	is the outer algorithm iterations count.

Reimplemented from ROL::Objective< Real >.

Definition at line 105 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::barrier_, and ROL::InteriorPoint::PenalizedObjective< Real >::obj_.

template<class Real >

Real ROL::InteriorPoint::PenalizedObjective< Real >::value	(	const Vector< Real > &	x,
		Real &	tol
	)

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 111 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::barrier_, ROL::InteriorPoint::PenalizedObjective< Real >::fval_, ROL::InteriorPoint::PenalizedObjective< Real >::mu_, ROL::InteriorPoint::PenalizedObjective< Real >::nfval_, and ROL::InteriorPoint::PenalizedObjective< Real >::obj_.

template<class Real >

Real ROL::InteriorPoint::PenalizedObjective< Real >::getObjectiveValue ( void )

inline

Definition at line 122 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::fval_.

template<class Real >

void ROL::InteriorPoint::PenalizedObjective< Real >::gradient	(	Vector< Real > &	g,
		const Vector< Real > &	x,
		Real &	tol
	)

inlinevirtual

Compute gradient.

This function returns the objective function gradient.

Parameters

[out]	g	is the gradient.
[in]	x	is the current iterate.
[in]	tol	is a tolerance for inexact objective function computation.

The default implementation is a finite-difference approximation based on the function value. This requires the definition of a basis \(\{\phi_i\}\) for the optimization vectors x and the definition of a basis \(\{\psi_j\}\) for the dual optimization vectors (gradient vectors g). The bases must be related through the Riesz map, i.e., \( R \{\phi_i\} = \{\psi_j\}\), and this must be reflected in the implementation of the ROL::Vector::dual() method.

Reimplemented from ROL::Objective< Real >.

Definition at line 126 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::barrier_, ROL::InteriorPoint::PenalizedObjective< Real >::g_, ROL::InteriorPoint::PenalizedObjective< Real >::gnorm_, ROL::InteriorPoint::PenalizedObjective< Real >::mu_, ROL::InteriorPoint::PenalizedObjective< Real >::ngval_, ROL::Vector< Real >::norm(), ROL::InteriorPoint::PenalizedObjective< Real >::obj_, ROL::Vector< Real >::plus(), and ROL::InteriorPoint::PenalizedObjective< Real >::scratch_.

template<class Real >

void ROL::InteriorPoint::PenalizedObjective< Real >::getObjectiveGradient ( Vector< Real > & g )

inline

Definition at line 138 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::g_, and ROL::Vector< Real >::set().

template<class Real >

Real ROL::InteriorPoint::PenalizedObjective< Real >::getGradientNorm ( )

inline

Definition at line 142 of file ROL_InteriorPoint.hpp.

References ROL::InteriorPoint::PenalizedObjective< Real >::gnorm_.

template<class Real >

void ROL::InteriorPoint::PenalizedObjective< Real >::hessVec	(	Vector< Real > &	hv,
		const Vector< Real > &	v,
		const Vector< Real > &	x,
		Real &	tol
	)

inlinevirtual

Apply Hessian approximation to vector.

This function applies the Hessian of the objective function to the vector \(v\).

Parameters

[out]	hv	is the the action of the Hessian on \(v\).
[in]	v	is the direction vector.
[in]	x	is the current iterate.
[in]	tol	is a tolerance for inexact objective function computation.