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

#include <ROL_Algorithm.hpp>

Public Member Functions
virtual	~Algorithm ()

	Algorithm (const Teuchos::RCP< Step< Real > > &step, const Teuchos::RCP< StatusTest< Real > > &status, bool printHeader=false)
	Constructor, given a step and a status test. More...

	Algorithm (const Teuchos::RCP< Step< Real > > &step, const Teuchos::RCP< StatusTest< Real > > &status, const Teuchos::RCP< AlgorithmState< Real > > &state, bool printHeader=false)
	Constructor, given a step, a status test, and a previously defined algorithm state. More...

	Algorithm (const std::string &stepname, Teuchos::ParameterList &parlist, bool printHeader=false)
	Constructor, given a string, for the step, and a parameter list of various options. The status test is determined based on the step string. More...

virtual std::vector< std::string >	run (Vector< Real > &x, Objective< Real > &obj, bool print=false, std::ostream &outStream=std::cout)
	Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface. More...

virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, bool print=false, std::ostream &outStream=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. More...

virtual std::vector< std::string >	run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con, bool print=false, std::ostream &outStream=std::cout)
	Run algorithm on bound constrained problems (Type-B). This is the primary Type-B interface. More...

virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, bool print=false, std::ostream &outStream=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. More...

virtual std::vector< std::string >	run (Vector< Real > &x, Vector< Real > &l, Objective< Real > &obj, EqualityConstraint< Real > &con, bool print=false, std::ostream &outStream=std::cout)
	Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface. More...

virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, EqualityConstraint< Real > &con, bool print=false, std::ostream &outStream=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. More...

virtual std::vector< std::string >	run (Vector< Real > &x, Vector< Real > &l, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, bool print=false, std::ostream &outStream=std::cout)
	Run algorithm on equality and bound constrained problems (Type-EB). This is the primary Type-EB interface. More...

virtual std::vector< std::string >	run (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, bool print=false, std::ostream &outStream=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. More...

std::string	getIterHeader (void)

std::string	getIterInfo (bool withHeader=false)

Teuchos::RCP< const AlgorithmState< Real > >	getState (void) const

Private Attributes
Teuchos::RCP< Step< Real > >	step_

Teuchos::RCP< StatusTest< Real > >	status_

Teuchos::RCP< AlgorithmState< Real > >	state_

bool	printHeader_

Detailed Description

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

Provides an interface to run optimization algorithms.

Definition at line 70 of file ROL_Algorithm.hpp.

Constructor & Destructor Documentation

template<class Real>

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

inlinevirtual

Definition at line 80 of file ROL_Algorithm.hpp.

template<class Real>

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

inline

Constructor, given a step and a status test.

Definition at line 84 of file ROL_Algorithm.hpp.

template<class Real>

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

inline

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

Definition at line 96 of file ROL_Algorithm.hpp.

template<class Real>

ROL::Algorithm< Real >::Algorithm	(	const std::string &	stepname,
		Teuchos::ParameterList &	parlist,
		bool	printHeader = `false`
	)

inline

Constructor, given a string, for the step, and a parameter list of various options. The status test is determined based on the step string.

Definition at line 110 of file ROL_Algorithm.hpp.

References ROL::StatusTestFactory< Real >::getStatusTest(), ROL::StepFactory< Real >::getStep(), ROL::isValidStep(), ROL::stepFactory(), and ROL::StringToEStep().

Member Function Documentation

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`
	)

inlinevirtual

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

Definition at line 128 of file ROL_Algorithm.hpp.

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

Referenced by main(), and ROL::Algorithm< Real >::run().

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`
	)

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 141 of file ROL_Algorithm.hpp.

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

template<class Real>

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

inlinevirtual

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

Definition at line 154 of file ROL_Algorithm.hpp.

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

template<class Real>

virtual std::vector<std::string> ROL::Algorithm< Real >::run	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	con,
		bool	print = `false`,
		std::ostream &	outStream = `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 166 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::clone().

template<class Real>

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

inlinevirtual

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

Definition at line 221 of file ROL_Algorithm.hpp.

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

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,
		EqualityConstraint< Real > &	con,
		bool	print = `false`,
		std::ostream &	outStream = `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 237 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::clone().

template<class Real>

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

inlinevirtual

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

Definition at line 292 of file ROL_Algorithm.hpp.

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

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,
		EqualityConstraint< Real > &	con,
		BoundConstraint< Real > &	bnd,
		bool	print = `false`,
		std::ostream &	outStream = `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 306 of file ROL_Algorithm.hpp.

References ROL::Vector< Real >::clone().

template<class Real>

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

inline

Definition at line 359 of file ROL_Algorithm.hpp.

template<class Real>

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

inline

Definition at line 363 of file ROL_Algorithm.hpp.

template<class Real>

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

inline

Definition at line 367 of file ROL_Algorithm.hpp.

References ROL::Algorithm< Real >::state_.

Referenced by main().

Member Data Documentation

template<class Real>

Teuchos::RCP<Step<Real> > ROL::Algorithm< Real >::step_

private

Definition at line 72 of file ROL_Algorithm.hpp.

template<class Real>

Teuchos::RCP<StatusTest<Real> > ROL::Algorithm< Real >::status_

private

Definition at line 73 of file ROL_Algorithm.hpp.

template<class Real>

Teuchos::RCP<AlgorithmState<Real> > ROL::Algorithm< Real >::state_

private

Definition at line 74 of file ROL_Algorithm.hpp.

Referenced by ROL::Algorithm< Real >::getState().

template<class Real>

bool ROL::Algorithm< Real >::printHeader_

private

Definition at line 76 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

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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