ROL::OptimizationSolver< Real > Class Template Reference

Provides a simplified interface for solving a wide range of optimization problems. More...

#include <ROL_OptimizationSolver.hpp>

Public Member Functions
	OptimizationSolver (OptimizationProblem< Real > &opt, Teuchos::ParameterList &parlist)
virtual std::vector< std::string >	getOutput ()
virtual int	solve ()
virtual int	solve (std::ostream &outStream)
Teuchos::RCP< const AlgorithmState< Real > >	getAlgorithmState ()

Private Types
typedef Vector< Real >	V
typedef Objective< Real >	OBJ
typedef EqualityConstraint< Real >	EQCON
typedef BoundConstraint< Real >	BND

Private Attributes
Teuchos::RCP< Algorithm< Real > >	algo_
Teuchos::RCP< Step< Real > >	step_
Teuchos::RCP< StatusTest< Real > >	status_
Teuchos::RCP< AlgorithmState< Real > >	state_
Teuchos::RCP< V >	x_
Teuchos::RCP< V >	g_
Teuchos::RCP< V >	l_
Teuchos::RCP< V >	c_
Teuchos::RCP< OBJ >	obj_
Teuchos::RCP< BND >	bnd_
Teuchos::RCP< EQCON >	eqcon_
std::vector< std::string >	output_
EProblem	problemType_

Detailed Description

template<class Real>
class ROL::OptimizationSolver< Real >

Provides a simplified interface for solving a wide range of optimization problems.

Definition at line 62 of file ROL_OptimizationSolver.hpp.

Member Typedef Documentation

V

template<class Real>

typedef Vector<Real> ROL::OptimizationSolver< Real >::V

private

Definition at line 64 of file ROL_OptimizationSolver.hpp.

OBJ

template<class Real>

typedef Objective<Real> ROL::OptimizationSolver< Real >::OBJ

private

Definition at line 65 of file ROL_OptimizationSolver.hpp.

EQCON

template<class Real>

typedef EqualityConstraint<Real> ROL::OptimizationSolver< Real >::EQCON

private

Definition at line 66 of file ROL_OptimizationSolver.hpp.

BND

template<class Real>

typedef BoundConstraint<Real> ROL::OptimizationSolver< Real >::BND

private

Definition at line 67 of file ROL_OptimizationSolver.hpp.

Constructor & Destructor Documentation

OptimizationSolver()

template<class Real>

ROL::OptimizationSolver< Real >::OptimizationSolver ( OptimizationProblem< Real > &  opt, Teuchos::ParameterList &  parlist  )

inline

Definition at line 91 of file ROL_OptimizationSolver.hpp.

References ROL::EProblemToString(), ROL::OptimizationProblem< Real >::getBoundConstraint(), ROL::OptimizationProblem< Real >::getEqualityConstraint(), ROL::OptimizationProblem< Real >::getMultiplierVector(), ROL::OptimizationProblem< Real >::getObjective(), ROL::OptimizationProblem< Real >::getProblemType(), ROL::OptimizationProblem< Real >::getSolutionVector(), ROL::StatusTestFactory< Real >::getStatusTest(), ROL::StepFactory< Real >::getStep(), ROL::isCompatibleStep(), ROL::isValidStep(), ROL::STEP_AUGMENTEDLAGRANGIAN, ROL::STEP_MOREAUYOSIDAPENALTY, ROL::stepFactory(), ROL::StringToEStep(), ROL::TYPE_E, and ROL::TYPE_EB.

Member Function Documentation

getOutput()

template<class Real>

virtual std::vector<std::string> ROL::OptimizationSolver< Real >::getOutput ( )

inlinevirtual

Definition at line 151 of file ROL_OptimizationSolver.hpp.

References ROL::OptimizationSolver< Real >::output_.

solve() [1/2]

template<class Real>

virtual int ROL::OptimizationSolver< Real >::solve ( )

inlinevirtual

Definition at line 155 of file ROL_OptimizationSolver.hpp.

Referenced by main().

solve() [2/2]

template<class Real>

virtual int ROL::OptimizationSolver< Real >::solve ( std::ostream &  outStream )

inlinevirtual

Definition at line 160 of file ROL_OptimizationSolver.hpp.

References ROL::TYPE_B, ROL::TYPE_E, ROL::TYPE_EB, ROL::TYPE_LAST, and ROL::TYPE_U.

getAlgorithmState()

template<class Real>

Teuchos::RCP<const AlgorithmState<Real> > ROL::OptimizationSolver< Real >::getAlgorithmState ( )

inline

Definition at line 189 of file ROL_OptimizationSolver.hpp.

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

Member Data Documentation

algo_

template<class Real>

Teuchos::RCP<Algorithm<Real> > ROL::OptimizationSolver< Real >::algo_

private

Definition at line 71 of file ROL_OptimizationSolver.hpp.

step_

template<class Real>

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

private

Definition at line 72 of file ROL_OptimizationSolver.hpp.

status_

template<class Real>

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

private

Definition at line 73 of file ROL_OptimizationSolver.hpp.

state_

template<class Real>

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

private

Definition at line 74 of file ROL_OptimizationSolver.hpp.

Referenced by ROL::OptimizationSolver< Real >::getAlgorithmState().

x_

template<class Real>

Teuchos::RCP<V> ROL::OptimizationSolver< Real >::x_

private

Definition at line 76 of file ROL_OptimizationSolver.hpp.

g_

template<class Real>

Teuchos::RCP<V> ROL::OptimizationSolver< Real >::g_

private

Definition at line 77 of file ROL_OptimizationSolver.hpp.

l_

template<class Real>

Teuchos::RCP<V> ROL::OptimizationSolver< Real >::l_

private

Definition at line 78 of file ROL_OptimizationSolver.hpp.

c_

template<class Real>

Teuchos::RCP<V> ROL::OptimizationSolver< Real >::c_

private

Definition at line 79 of file ROL_OptimizationSolver.hpp.

obj_

template<class Real>

Teuchos::RCP<OBJ> ROL::OptimizationSolver< Real >::obj_

private

Definition at line 81 of file ROL_OptimizationSolver.hpp.

bnd_

template<class Real>

Teuchos::RCP<BND> ROL::OptimizationSolver< Real >::bnd_

private

Definition at line 82 of file ROL_OptimizationSolver.hpp.

eqcon_

template<class Real>

Teuchos::RCP<EQCON> ROL::OptimizationSolver< Real >::eqcon_

private

Definition at line 83 of file ROL_OptimizationSolver.hpp.

output_

template<class Real>

std::vector<std::string> ROL::OptimizationSolver< Real >::output_

private

Definition at line 85 of file ROL_OptimizationSolver.hpp.

Referenced by ROL::OptimizationSolver< Real >::getOutput().

problemType_

template<class Real>

EProblem ROL::OptimizationSolver< Real >::problemType_

private

Definition at line 87 of file ROL_OptimizationSolver.hpp.

---

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

• ROL_OptimizationSolver.hpp