#include <ROL_Constraint_SerialSimOpt.hpp>

Inheritance diagram for ROL::ROL::TypeU::LineSearchAlgorithm< Real >:

Public Member Functions
	LineSearchAlgorithm (ParameterList &parlist, const Ptr< Secant< Real > > &secant=nullPtr, const Ptr< DescentDirection_U< Real > > &descent=nullPtr, const Ptr< LineSearch_U< Real > > &lineSearch=nullPtr)
	Constructor.
void	initialize (const Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, std::ostream &outStream=std::cout)
void	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, std::ostream &outStream=std::cout) override
	Run algorithm on unconstrained problems (Type-U). 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, bool print_header=false) const override
	Print iterate status.
Public Member Functions inherited from ROL::ROL::TypeU::Algorithm< Real >
virtual	~Algorithm ()
	Algorithm ()
	Constructor, given a step and a status test.
void	setStatusTest (const Ptr< StatusTest< Real > > &status, bool combineStatus=false)
virtual void	run (Problem< Real > &problem, std::ostream &outStream=std::cout)
	Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
virtual void	run (Vector< Real > &x, Objective< Real > &obj, std::ostream &outStream=std::cout)
	Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
virtual void	run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &linear_con, Vector< Real > &linear_mul, std::ostream &outStream=std::cout)
	Run algorithm on unconstrained problems with explicit linear equality constraints (Type-U). This is the primary Type-U with explicit linear equality constraints interface.
virtual void	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &linear_con, Vector< Real > &linear_mul, const Vector< Real > &linear_c, std::ostream &outStream=std::cout)
	Run algorithm on unconstrained problems with explicit linear equality constraints (Type-U). 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 Attributes
Ptr< DescentDirection_U< Real > >	desc_
	Unglobalized step object.
Ptr< LineSearch_U< Real > >	lineSearch_
	Line-search object.
EDescentU	edesc_
	enum determines type of descent direction
ELineSearchU	els_
	enum determines type of line search
ECurvatureConditionU	econd_
	enum determines type of curvature condition
bool	acceptLastAlpha_
	For backwards compatibility. When max function evaluations are reached take last step.
bool	usePreviousAlpha_
	If true, use the previously accepted step length (if any) as the new initial step length.
int	verbosity_
bool	printHeader_
int	ls_nfval_
int	ls_ngrad_
int	SPflag_
int	SPiter_
std::string	lineSearchName_
std::string	descentName_

Additional Inherited Members
Protected Member Functions inherited from ROL::ROL::TypeU::Algorithm< Real >
void	initialize (const Vector< Real > &x, const Vector< Real > &g)
Protected Attributes inherited from ROL::ROL::TypeU::Algorithm< Real >
const Ptr< CombinedStatusTest< Real > >	status_
const Ptr< AlgorithmState< Real > >	state_

Detailed Description

template<class Real>
class ROL::ROL::TypeU::LineSearchAlgorithm< Real >

Definition at line 101 of file ROL_Constraint_SerialSimOpt.hpp.

Constructor & Destructor Documentation

◆ LineSearchAlgorithm()

template<typename Real>

ROL::TypeU::LineSearchAlgorithm< Real >::LineSearchAlgorithm	(	ParameterList &	parlist,
		const Ptr< Secant< Real > > &	secant = nullPtr,
		const Ptr< DescentDirection_U< Real > > &	descent = nullPtr,
		const Ptr< LineSearch_U< Real > > &	lineSearch = nullPtr )

Constructor.

Standard constructor to build a LineSearchStep object. Algorithmic specifications are passed in through a ROL::ParameterList. The line-search type, secant type, Krylov type, or nonlinear CG type can be set using user-defined objects.

Parameters

[in]	parlist	is a parameter list containing algorithmic specifications
[in]	lineSearch	is a user-defined descent direction object
[in]	lineSearch	is a user-defined line search object

Definition at line 54 of file ROL_TypeU_LineSearchAlgorithm_Def.hpp.

References acceptLastAlpha_, ROL::ROL::TypeU::Algorithm< Real >::Algorithm(), ROL::ROL::CURVATURECONDITION_U_WOLFE, desc_, ROL::ROL::DESCENT_U_USERDEFINED, ROL::DescentDirectionUFactory(), descentName_, econd_, edesc_, els_, lineSearch_, ROL::ROL::LINESEARCH_U_USERDEFINED, lineSearchName_, ROL::LineSearchUFactory(), printHeader_, ROL::ROL::TypeU::Algorithm< Real >::status_, ROL::StringToECurvatureConditionU(), ROL::StringToEDescentU(), ROL::StringToELineSearchU(), and verbosity_.

Member Function Documentation

◆ initialize()

template<typename Real>

void ROL::TypeU::LineSearchAlgorithm< Real >::initialize	(	const Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		std::ostream &	outStream = std::cout )

Definition at line 93 of file ROL_TypeU_LineSearchAlgorithm_Def.hpp.

References desc_, ROL::ROL::Objective< Real >::gradient(), ROL::ROL::Initial, ROL::TypeU::Algorithm< Real >::initialize(), lineSearch_, ROL::ROL::ROL_EPSILON(), ROL::ROL_INF(), ROL::ROL::TypeU::Algorithm< Real >::state_, ROL::ROL::Objective< Real >::update(), and ROL::ROL::Objective< Real >::value().

◆ run()

template<typename Real>

void ROL::TypeU::LineSearchAlgorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		std::ostream &	outStream = std::cout )

overridevirtual

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

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

Definition at line 113 of file ROL_TypeU_LineSearchAlgorithm_Def.hpp.

References ROL::ROL::Accept, acceptLastAlpha_, ROL::ROL::Vector< Real >::clone(), desc_, ROL::ROL::Objective< Real >::gradient(), initialize(), lineSearch_, ls_nfval_, ls_ngrad_, ROL::ROL::Vector< Real >::plus(), printHeader_, ROL::ROL::ROL_EPSILON(), SPflag_, SPiter_, ROL::ROL::TypeU::Algorithm< Real >::state_, ROL::ROL::TypeU::Algorithm< Real >::status_, ROL::ROL::Objective< Real >::update(), ROL::ROL::Objective< Real >::value(), verbosity_, ROL::TypeU::Algorithm< Real >::writeExitStatus(), and writeOutput().