Provides an interface to run the Moreau-Yosida algorithm. More...

#include <ROL_TypeB_InteriorPointAlgorithm.hpp>

Inheritance diagram for ROL::TypeB::InteriorPointAlgorithm< Real >:

Public Member Functions
	InteriorPointAlgorithm (ParameterList &list, const Ptr< Secant< Real > > &secant=nullPtr)
void	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, std::ostream &outStream=std::cout) override
	Run algorithm on bound constrained problems (Type-B). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
void	writeHeader (std::ostream &os) const override
	Print iterate header.
void	writeName (std::ostream &os) const override
	Print step name.
void	writeOutput (std::ostream &os, const bool write_header=false) const override
	Print iterate status.
Public Member Functions inherited from ROL::TypeB::Algorithm< Real >
virtual	~Algorithm ()
	Algorithm ()
	Constructor, given a step and a status test.
void	setStatusTest (const Ptr< StatusTest< Real > > &status, const bool combineStatus=false)
virtual void	run (Problem< Real > &problem, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems (Type-B). This is the primary Type-B interface.
virtual void	run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems (Type-B). This is the primary Type-B interface.
virtual void	run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems with explicit linear constraints (Type-B). This is the primary Type-B with explicit linear constraints interface.
virtual void	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems with explicit linear constraints (Type-B). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
virtual void	run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &linear_icon, Vector< Real > &linear_imul, BoundConstraint< Real > &linear_ibnd, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems with explicit linear constraints (Type-B). This is the primary Type-B with explicit linear constraints interface.
virtual void	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &linear_icon, Vector< Real > &linear_imul, BoundConstraint< Real > &linear_ibnd, const Vector< Real > &linear_ires, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems with explicit linear constraints (Type-B). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
virtual void	run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, Constraint< Real > &linear_icon, Vector< Real > &linear_imul, BoundConstraint< Real > &linear_ibnd, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems with explicit linear constraints (Type-B). This is the primary Type-B with explicit linear constraints interface.
virtual void	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, Constraint< Real > &linear_icon, Vector< Real > &linear_imul, BoundConstraint< Real > &linear_ibnd, const Vector< Real > &linear_ires, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems with explicit linear constraints (Type-B). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
virtual void	writeExitStatus (std::ostream &os) const
Ptr< const AlgorithmState< Real > >	getState () const
void	reset ()

Private Member Functions
void	initialize (Vector< Real > &x, const Vector< Real > &g, InteriorPointObjective< Real > &ipobj, BoundConstraint< Real > &bnd, Vector< Real > &pwa, std::ostream &outStream=std::cout)
void	updateState (const Vector< Real > &x, InteriorPointObjective< Real > &ipobj, BoundConstraint< Real > &bnd, Vector< Real > &pwa, std::ostream &outStream=std::cout)

Private Attributes
const Ptr< Secant< Real > >	secant_
Real	mumin_
Real	mumax_
Real	rho_
bool	useLinearDamping_
Real	kappaD_
Real	gtol_
Real	stol_
Real	gtolrate_
Real	mingtol_
ROL::ParameterList	list_
int	subproblemIter_
std::string	stepname_
bool	print_
int	verbosity_
bool	writeHeader_
bool	hasPolyProj_

Additional Inherited Members
Protected Member Functions inherited from ROL::TypeB::Algorithm< Real >
void	initialize (const Vector< Real > &x, const Vector< Real > &g)
Real	optimalityCriterion (const Vector< Real > &x, const Vector< Real > &g, Vector< Real > &primal, std::ostream &outStream=std::cout) const
Protected Attributes inherited from ROL::TypeB::Algorithm< Real >
const Ptr< CombinedStatusTest< Real > >	status_
const Ptr< AlgorithmState< Real > >	state_
Ptr< PolyhedralProjection< Real > >	proj_

Detailed Description

template<typename Real>
class ROL::TypeB::InteriorPointAlgorithm< Real >

Provides an interface to run the Moreau-Yosida algorithm.

Definition at line 25 of file ROL_TypeB_InteriorPointAlgorithm.hpp.

Constructor & Destructor Documentation

◆ InteriorPointAlgorithm()

template<typename Real>

ROL::TypeB::InteriorPointAlgorithm< Real >::InteriorPointAlgorithm	(	ParameterList &	list,
		const Ptr< Secant< Real > > &	secant = nullPtr )

Definition at line 19 of file ROL_TypeB_InteriorPointAlgorithm_Def.hpp.

References ROL::TypeB::Algorithm< Real >::Algorithm(), gtol_, gtolrate_, kappaD_, list_, mingtol_, mumax_, mumin_, print_, rho_, secant_, ROL::TypeB::Algorithm< Real >::state_, ROL::TypeB::Algorithm< Real >::status_, stepname_, stol_, subproblemIter_, useLinearDamping_, verbosity_, and writeHeader_.

Member Function Documentation

◆ initialize()

template<typename Real>

void ROL::TypeB::InteriorPointAlgorithm< Real >::initialize	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		InteriorPointObjective< Real > &	ipobj,
		BoundConstraint< Real > &	bnd,
		Vector< Real > &	pwa,
		std::ostream &	outStream = std::cout )

private

Definition at line 54 of file ROL_TypeB_InteriorPointAlgorithm_Def.hpp.

References hasPolyProj_, ROL::TypeB::Algorithm< Real >::initialize(), ROL::TypeB::Algorithm< Real >::proj_, ROL::BoundConstraint< Real >::projectInterior(), ROL::TypeB::Algorithm< Real >::state_, and updateState().

◆ updateState()

template<typename Real>

void ROL::TypeB::InteriorPointAlgorithm< Real >::updateState	(	const Vector< Real > &	x,
		InteriorPointObjective< Real > &	ipobj,
		BoundConstraint< Real > &	bnd,
		Vector< Real > &	pwa,
		std::ostream &	outStream = std::cout )

private

Definition at line 77 of file ROL_TypeB_InteriorPointAlgorithm_Def.hpp.

References ROL::Vector< Real >::axpy(), ROL::InteriorPointObjective< Real >::getObjectiveValue(), ROL::InteriorPointObjective< Real >::gradient(), ROL::Initial, ROL::Vector< Real >::norm(), ROL::TypeB::Algorithm< Real >::proj_, ROL::ROL_EPSILON(), ROL::Vector< Real >::set(), ROL::TypeB::Algorithm< Real >::state_, and ROL::InteriorPointObjective< Real >::update().

Referenced by initialize(), and run().

◆ run()

template<typename Real>

void ROL::TypeB::InteriorPointAlgorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	bnd,
		std::ostream &	outStream = std::cout )

overridevirtual

Run algorithm on bound constrained problems (Type-B). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.

Implements ROL::TypeB::Algorithm< Real >.

Definition at line 107 of file ROL_TypeB_InteriorPointAlgorithm_Def.hpp.

References ROL::TypeU::AlgorithmFactory(), ROL::Vector< Real >::clone(), ROL::EXITSTATUS_CONVERGED, gtol_, gtolrate_, hasPolyProj_, initialize(), kappaD_, list_, mingtol_, mumax_, mumin_, ROL::TypeB::Algorithm< Real >::proj_, rho_, secant_, ROL::TypeB::Algorithm< Real >::state_, ROL::TypeB::Algorithm< Real >::status_, stol_, subproblemIter_, ROL::InteriorPointObjective< Real >::updatePenalty(), updateState(), useLinearDamping_, verbosity_, ROL::TypeB::Algorithm< Real >::writeExitStatus(), writeHeader_, and writeOutput().