Provides an interface to run unconstrained optimization algorithms. More...

#include <ROL_Algorithm.hpp>

Public Member Functions
virtual	~Algorithm ()
	Algorithm (const ROL::Ptr< Step< Real > > &step, const ROL::Ptr< StatusTest< Real > > &status, bool printHeader=false)
	Constructor, given a step and a status test.
	Algorithm (const ROL::Ptr< Step< Real > > &step, const ROL::Ptr< StatusTest< Real > > &status, const ROL::Ptr< AlgorithmState< Real > > &state, bool printHeader=false)
	Constructor, given a step, a status test, and a previously defined algorithm state.
virtual std::vector< std::string >	run (Vector< Real > &x, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.
virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	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.
virtual std::vector< std::string >	run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	Run algorithm on bound constrained problems (Type-B). This is the primary Type-B interface.
virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	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.
virtual std::vector< std::string >	run (Vector< Real > &x, Vector< Real > &l, Objective< Real > &obj, Constraint< Real > &con, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.
virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, Constraint< Real > &con, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	Run algorithm on equality constrained problems (Type-E). This general interface supports the use of dual optimization and constraint vector spaces, where the user does not define the dual() method.
virtual std::vector< std::string >	run (Vector< Real > &x, Vector< Real > &l, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	Run algorithm on equality and bound constrained problems (Type-EB). This is the primary Type-EB interface.
virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, bool print=false, std::ostream &outStream=std::cout, bool printVectors=false, std::ostream &vectorStream=std::cout)
	Run algorithm on equality and bound constrained problems (Type-EB). This general interface supports the use of dual optimization and constraint vector spaces, where the user does not define the dual() method.
std::string	getIterHeader (void)
std::string	getIterInfo (bool withHeader=false)
ROL::Ptr< const AlgorithmState< Real > >	getState (void) const
void	reset (void)

Private Attributes
ROL::Ptr< Step< Real > >	step_
ROL::Ptr< StatusTest< Real > >	status_
ROL::Ptr< AlgorithmState< Real > >	state_
bool	printHeader_

Detailed Description

template<class Real>
class ROL::Algorithm< Real >

Provides an interface to run unconstrained optimization algorithms.

Provides an interface to run optimization algorithms.

Definition at line 29 of file ROL_Algorithm.hpp.

Constructor & Destructor Documentation

◆ ~Algorithm()

template<class Real>

virtual ROL::Algorithm< Real >::~Algorithm ( )

inlinevirtual

Definition at line 39 of file ROL_Algorithm.hpp.

◆ Algorithm() [1/2]

template<class Real>

ROL::Algorithm< Real >::Algorithm	(	const ROL::Ptr< Step< Real > > &	step,
		const ROL::Ptr< StatusTest< Real > > &	status,
		bool	printHeader = false )

inline

Constructor, given a step and a status test.

Definition at line 43 of file ROL_Algorithm.hpp.

References printHeader_, state_, status_, and step_.

◆ Algorithm() [2/2]

template<class Real>

ROL::Algorithm< Real >::Algorithm	(	const ROL::Ptr< Step< Real > > &	step,
		const ROL::Ptr< StatusTest< Real > > &	status,
		const ROL::Ptr< AlgorithmState< Real > > &	state,
		bool	printHeader = false )

inline

Constructor, given a step, a status test, and a previously defined algorithm state.

Definition at line 55 of file ROL_Algorithm.hpp.

References printHeader_, state_, status_, and step_.

Member Function Documentation

◆ run() [1/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		Objective< Real > &	obj,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface.

Definition at line 68 of file ROL_Algorithm.hpp.

References ROL::BoundConstraint< Real >::deactivate(), ROL::Vector< Real >::dual(), and run().

Referenced by main(), main(), run(), run(), run(), run(), and run().

◆ run() [2/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

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.

Definition at line 83 of file ROL_Algorithm.hpp.

References ROL::BoundConstraint< Real >::deactivate(), and run().

◆ run() [3/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	bnd,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

Run algorithm on bound constrained problems (Type-B). This is the primary Type-B interface.

Definition at line 98 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::dual(), and run().

◆ run() [4/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	bnd,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

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.

Definition at line 112 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::clone(), ROL::EExitStatusToString(), ROL::Vector< Real >::print(), printHeader_, state_, status_, and step_.

◆ run() [5/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		Vector< Real > &	l,
		Objective< Real > &	obj,
		Constraint< Real > &	con,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.

Definition at line 186 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::dual(), and run().

◆ run() [6/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Vector< Real > &	l,
		const Vector< Real > &	c,
		Objective< Real > &	obj,
		Constraint< Real > &	con,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

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

Definition at line 204 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::clone(), ROL::EExitStatusToString(), ROL::Vector< Real >::print(), printHeader_, state_, status_, and step_.

◆ run() [7/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		Vector< Real > &	l,
		Objective< Real > &	obj,
		Constraint< Real > &	con,
		BoundConstraint< Real > &	bnd,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

Run algorithm on equality and bound constrained problems (Type-EB). This is the primary Type-EB interface.

Definition at line 278 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::dual(), and run().

◆ run() [8/8]

template<class Real>

virtual std::vector< std::string > ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Vector< Real > &	l,
		const Vector< Real > &	c,
		Objective< Real > &	obj,
		Constraint< Real > &	con,
		BoundConstraint< Real > &	bnd,
		bool	print = false,
		std::ostream &	outStream = std::cout,
		bool	printVectors = false,
		std::ostream &	vectorStream = std::cout )

inlinevirtual

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

Definition at line 294 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::clone(), ROL::EExitStatusToString(), ROL::Vector< Real >::print(), printHeader_, state_, status_, and step_.

◆ getIterHeader()

template<class Real>

std::string ROL::Algorithm< Real >::getIterHeader ( void )

inline

Definition at line 364 of file ROL_Algorithm.hpp.

References step_.

◆ getIterInfo()

template<class Real>

std::string ROL::Algorithm< Real >::getIterInfo ( bool withHeader = false )

inline

Definition at line 368 of file ROL_Algorithm.hpp.

References state_, and step_.

◆ getState()

template<class Real>

ROL::Ptr< const AlgorithmState< Real > > ROL::Algorithm< Real >::getState ( void ) const

inline

Definition at line 372 of file ROL_Algorithm.hpp.

References state_.

◆ reset()

template<class Real>

void ROL::Algorithm< Real >::reset ( void )

inline

Definition at line 376 of file ROL_Algorithm.hpp.

References state_.

Member Data Documentation

◆ step_

template<class Real>

ROL::Ptr<Step<Real> > ROL::Algorithm< Real >::step_

private

Definition at line 31 of file ROL_Algorithm.hpp.

Referenced by Algorithm(), Algorithm(), getIterHeader(), getIterInfo(), run(), run(), and run().

◆ status_

template<class Real>

ROL::Ptr<StatusTest<Real> > ROL::Algorithm< Real >::status_

private

Definition at line 32 of file ROL_Algorithm.hpp.

Referenced by Algorithm(), Algorithm(), run(), run(), and run().

◆ state_

template<class Real>

ROL::Ptr<AlgorithmState<Real> > ROL::Algorithm< Real >::state_

private

Definition at line 33 of file ROL_Algorithm.hpp.

Referenced by Algorithm(), Algorithm(), getIterInfo(), getState(), reset(), run(), run(), and run().

◆ printHeader_

template<class Real>

bool ROL::Algorithm< Real >::printHeader_

private

Definition at line 35 of file ROL_Algorithm.hpp.

Referenced by Algorithm(), Algorithm(), run(), run(), and run().

The documentation for this class was generated from the following file:

ROL_Algorithm.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Algorithm()

◆ Algorithm() [1/2]

◆ Algorithm() [2/2]

Member Function Documentation

◆ run() [1/8]

◆ run() [2/8]

◆ run() [3/8]

◆ run() [4/8]

◆ run() [5/8]

◆ run() [6/8]

◆ run() [7/8]

◆ run() [8/8]

◆ getIterHeader()

◆ getIterInfo()

◆ getState()

◆ reset()

Member Data Documentation

◆ step_

◆ status_

◆ state_

◆ printHeader_