Provides an interface to run the projected gradient algorithm. More...

#include <ROL_TypeB_GradientAlgorithm.hpp>

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

Public Member Functions
	GradientAlgorithm (ParameterList &list)
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, Objective< Real > &obj, BoundConstraint< Real > &bnd, std::ostream &outStream=std::cout)

Private Attributes
int	maxit_
Real	alpha0_
Real	alpha0bnd_
Real	rhodec_
Real	rhoinc_
Real	c1_
Real	maxAlpha_
bool	useralpha_
bool	usePrevAlpha_
bool	useAdapt_
bool	normAlpha_
int	verbosity_
bool	writeHeader_

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

Provides an interface to run the projected gradient algorithm.

Definition at line 23 of file ROL_TypeB_GradientAlgorithm.hpp.

Constructor & Destructor Documentation

◆ GradientAlgorithm()

template<typename Real>

ROL::TypeB::GradientAlgorithm< Real >::GradientAlgorithm ( ParameterList & list )

Definition at line 17 of file ROL_TypeB_GradientAlgorithm_Def.hpp.

References alpha0_, alpha0bnd_, c1_, maxAlpha_, maxit_, normAlpha_, rhodec_, rhoinc_, ROL::TypeB::Algorithm< Real >::status_, useAdapt_, usePrevAlpha_, useralpha_, verbosity_, and writeHeader_.

Member Function Documentation

◆ initialize()

template<typename Real>

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

private

Definition at line 40 of file ROL_TypeB_GradientAlgorithm_Def.hpp.

References alpha0_, alpha0bnd_, ROL::Objective< Real >::gradient(), ROL::Initial, ROL::TypeB::Algorithm< Real >::initialize(), maxAlpha_, normAlpha_, ROL::TypeB::Algorithm< Real >::proj_, ROL::Revert, ROL::ROL_EPSILON(), ROL::ROL_INF(), ROL::TypeB::Algorithm< Real >::state_, ROL::Trial, ROL::Objective< Real >::update(), useralpha_, and ROL::Objective< Real >::value().

◆ run()

template<typename Real>

void ROL::TypeB::GradientAlgorithm< 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 92 of file ROL_TypeB_GradientAlgorithm_Def.hpp.

References ROL::Accept, alpha0_, c1_, ROL::Vector< Real >::clone(), ROL::Objective< Real >::gradient(), initialize(), maxAlpha_, maxit_, ROL::TypeB::Algorithm< Real >::proj_, ROL::Revert, rhodec_, rhoinc_, ROL::ROL_EPSILON(), ROL::ROL_INF(), ROL::Vector< Real >::set(), ROL::TypeB::Algorithm< Real >::state_, ROL::TypeB::Algorithm< Real >::status_, ROL::Trial, ROL::Objective< Real >::update(), useAdapt_, usePrevAlpha_, ROL::Objective< Real >::value(), verbosity_, ROL::TypeB::Algorithm< Real >::writeExitStatus(), writeHeader_, and writeOutput().