Provides an interface to run 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

Provides an interface to run optimization algorithms.

Provides an interface to run unconstrained optimization algorithms.

Constructor & Destructor Documentation

◆ ~Algorithm()

virtual Algorithm::~Algorithm ( )

inlinevirtual

Definition at line 73 of file ROL_Algorithm.hpp.

◆ Algorithm() [1/2]

Algorithm::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 77 of file ROL_Algorithm.hpp.

◆ Algorithm() [2/2]

Algorithm::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 89 of file ROL_Algorithm.hpp.

Member Function Documentation

◆ run() [1/8]

virtual std::vector< std::string > Algorithm::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 102 of file ROL_Algorithm.hpp.

References Algorithm::run().

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

◆ run() [2/8]

virtual std::vector< std::string > Algorithm::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 117 of file ROL_Algorithm.hpp.

References Algorithm::run().

◆ run() [3/8]

virtual std::vector< std::string > Algorithm::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 132 of file ROL_Algorithm.hpp.

References Algorithm::run().

◆ run() [4/8]

virtual std::vector< std::string > Algorithm::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 146 of file ROL_Algorithm.hpp.

◆ run() [5/8]

virtual std::vector< std::string > Algorithm::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 220 of file ROL_Algorithm.hpp.

References Algorithm::run().

◆ run() [6/8]

virtual std::vector< std::string > Algorithm::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 238 of file ROL_Algorithm.hpp.

◆ run() [7/8]

virtual std::vector< std::string > Algorithm::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 312 of file ROL_Algorithm.hpp.

References Algorithm::run().

◆ run() [8/8]

virtual std::vector< std::string > Algorithm::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 328 of file ROL_Algorithm.hpp.

◆ getIterHeader()

std::string Algorithm::getIterHeader ( void )

inline

Definition at line 398 of file ROL_Algorithm.hpp.

◆ getIterInfo()

std::string Algorithm::getIterInfo ( bool withHeader = false )

inline

Definition at line 402 of file ROL_Algorithm.hpp.

◆ getState()

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

inline

Definition at line 406 of file ROL_Algorithm.hpp.

◆ reset()

void Algorithm::reset ( void )

inline

Definition at line 410 of file ROL_Algorithm.hpp.

Member Data Documentation

◆ step_

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

private

Definition at line 65 of file ROL_Algorithm.hpp.

◆ status_

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

private

Definition at line 66 of file ROL_Algorithm.hpp.

◆ state_

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

private

Definition at line 67 of file ROL_Algorithm.hpp.

◆ printHeader_

bool Algorithm::printHeader_

private

Definition at line 69 of file ROL_Algorithm.hpp.

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_