ROL::OptimizationProblem< Real > Class Template Reference

#include <ROL_OptimizationProblem.hpp>

Inheritance diagram for ROL::OptimizationProblem< Real >:

Public Member Functions
virtual	~OptimizationProblem (void)
	OptimizationProblem (void)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< BoundConstraint< Real > > &bnd=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &parlist=Teuchos::null)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< EqualityConstraint< Real > > &con, const Teuchos::RCP< Vector< Real > > &mul, const Teuchos::RCP< Teuchos::ParameterList > &parlist=Teuchos::null)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< BoundConstraint< Real > > &bnd, const Teuchos::RCP< EqualityConstraint< Real > > &con, const Teuchos::RCP< Vector< Real > > &mul, const Teuchos::RCP< Teuchos::ParameterList > &parlist=Teuchos::null)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< InequalityConstraint< Real > > &incon, const Teuchos::RCP< Vector< Real > > &inmul, const Teuchos::RCP< Teuchos::ParameterList > &parlist)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< BoundConstraint< Real > > &bnd, const Teuchos::RCP< InequalityConstraint< Real > > &incon, const Teuchos::RCP< Vector< Real > > &inmul, const Teuchos::RCP< Teuchos::ParameterList > &parlist)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< EqualityConstraint< Real > > &eqcon, const Teuchos::RCP< Vector< Real > > &eqmul, const Teuchos::RCP< InequalityConstraint< Real > > &incon, const Teuchos::RCP< Vector< Real > > &inmul, const Teuchos::RCP< Teuchos::ParameterList > &parlist)
	OptimizationProblem (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &sol, const Teuchos::RCP< BoundConstraint< Real > > &bnd, const Teuchos::RCP< EqualityConstraint< Real > > &eqcon, const Teuchos::RCP< Vector< Real > > &eqmul, const Teuchos::RCP< InequalityConstraint< Real > > &incon, const Teuchos::RCP< Vector< Real > > &inmul, const Teuchos::RCP< Teuchos::ParameterList > &parlist)
Teuchos::RCP< Objective< Real > >	getObjective (void)
void	setObjective (const Teuchos::RCP< Objective< Real > > &obj)
Teuchos::RCP< Vector< Real > >	getSolutionVector (void)
void	setSolutionVector (const Teuchos::RCP< Vector< Real > > &sol)
Teuchos::RCP< BoundConstraint< Real > >	getBoundConstraint (void)
void	setBoundConstraint (const Teuchos::RCP< BoundConstraint< Real > > &bnd)
Teuchos::RCP< EqualityConstraint< Real > >	getEqualityConstraint (void)
void	setEqualityConstraint (const Teuchos::RCP< EqualityConstraint< Real > > &con)
Teuchos::RCP< Vector< Real > >	getMultiplierVector (void)
void	setMultiplierVector (const Teuchos::RCP< Vector< Real > > &mul)
Teuchos::RCP< Teuchos::ParameterList >	getParameterList (void)
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &parlist)
virtual std::vector< std::vector< Real > >	checkObjectiveGradient (const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
virtual std::vector< std::vector< Real > >	checkObjectiveHessVec (const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)

Private Types
typedef PartitionedVector< Real >	PV
typedef PV::size_type	size_type

Private Attributes
Teuchos::RCP< Objective< Real > >	obj_
Teuchos::RCP< Vector< Real > >	sol_
Teuchos::RCP< BoundConstraint< Real > >	bnd_
Teuchos::RCP< EqualityConstraint< Real > >	con_
Teuchos::RCP< InequalityConstraint< Real > >	incon_
Teuchos::RCP< Vector< Real > >	mul_
Teuchos::RCP< Teuchos::ParameterList >	parlist_
bool	hasSlack_

Static Private Attributes
static const size_type	OPT = 0
static const size_type	SLACK = 1

Detailed Description

template<class Real>
class ROL::OptimizationProblem< Real >

Definition at line 69 of file ROL_OptimizationProblem.hpp.

Member Typedef Documentation

PV

template<class Real>

typedef PartitionedVector<Real> ROL::OptimizationProblem< Real >::PV

private

Definition at line 71 of file ROL_OptimizationProblem.hpp.

size_type

template<class Real>

typedef PV::size_type ROL::OptimizationProblem< Real >::size_type

private

Definition at line 72 of file ROL_OptimizationProblem.hpp.

Constructor & Destructor Documentation

~OptimizationProblem()

template<class Real>

virtual ROL::OptimizationProblem< Real >::~OptimizationProblem ( void  )

inlinevirtual

Definition at line 89 of file ROL_OptimizationProblem.hpp.

OptimizationProblem() [1/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( void  )

inline

Definition at line 91 of file ROL_OptimizationProblem.hpp.

OptimizationProblem() [2/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< BoundConstraint< Real > > &  bnd = Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &  parlist = Teuchos::null  )

inline

Definition at line 96 of file ROL_OptimizationProblem.hpp.

References ROL::CreatePartitionedVector().

OptimizationProblem() [3/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< EqualityConstraint< Real > > &  con, const Teuchos::RCP< Vector< Real > > &  mul, const Teuchos::RCP< Teuchos::ParameterList > &  parlist = Teuchos::null  )

inline

Definition at line 147 of file ROL_OptimizationProblem.hpp.

OptimizationProblem() [4/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< BoundConstraint< Real > > &  bnd, const Teuchos::RCP< EqualityConstraint< Real > > &  con, const Teuchos::RCP< Vector< Real > > &  mul, const Teuchos::RCP< Teuchos::ParameterList > &  parlist = Teuchos::null  )

inline

Definition at line 155 of file ROL_OptimizationProblem.hpp.

References ROL::CreatePartitionedVector().

OptimizationProblem() [5/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< InequalityConstraint< Real > > &  incon, const Teuchos::RCP< Vector< Real > > &  inmul, const Teuchos::RCP< Teuchos::ParameterList > &  parlist  )

inline

Definition at line 203 of file ROL_OptimizationProblem.hpp.

References ROL::CreatePartitionedVector().

OptimizationProblem() [6/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< BoundConstraint< Real > > &  bnd, const Teuchos::RCP< InequalityConstraint< Real > > &  incon, const Teuchos::RCP< Vector< Real > > &  inmul, const Teuchos::RCP< Teuchos::ParameterList > &  parlist  )

inline

Definition at line 246 of file ROL_OptimizationProblem.hpp.

References ROL::CreatePartitionedVector().

OptimizationProblem() [7/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< EqualityConstraint< Real > > &  eqcon, const Teuchos::RCP< Vector< Real > > &  eqmul, const Teuchos::RCP< InequalityConstraint< Real > > &  incon, const Teuchos::RCP< Vector< Real > > &  inmul, const Teuchos::RCP< Teuchos::ParameterList > &  parlist  )

inline

Definition at line 293 of file ROL_OptimizationProblem.hpp.

References ROL::CreatePartitionedVector().

OptimizationProblem() [8/8]

template<class Real>

ROL::OptimizationProblem< Real >::OptimizationProblem ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  sol, const Teuchos::RCP< BoundConstraint< Real > > &  bnd, const Teuchos::RCP< EqualityConstraint< Real > > &  eqcon, const Teuchos::RCP< Vector< Real > > &  eqmul, const Teuchos::RCP< InequalityConstraint< Real > > &  incon, const Teuchos::RCP< Vector< Real > > &  inmul, const Teuchos::RCP< Teuchos::ParameterList > &  parlist  )

inline

Definition at line 338 of file ROL_OptimizationProblem.hpp.

References ROL::CreatePartitionedVector().

Member Function Documentation

getObjective()

template<class Real>

Teuchos::RCP<Objective<Real> > ROL::OptimizationProblem< Real >::getObjective ( void  )

inline

Definition at line 387 of file ROL_OptimizationProblem.hpp.

References ROL::OptimizationProblem< Real >::obj_.

Referenced by ROL::Step< Real >::compute(), ROL::Step< Real >::initialize(), ROL::Algorithm< Real >::run(), and ROL::Step< Real >::update().

setObjective()

template<class Real>

void ROL::OptimizationProblem< Real >::setObjective ( const Teuchos::RCP< Objective< Real > > &  obj )

inline

Definition at line 391 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::StochasticProblem< Real >::setObjective().

getSolutionVector()

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::OptimizationProblem< Real >::getSolutionVector ( void  )

inline

Definition at line 395 of file ROL_OptimizationProblem.hpp.

References ROL::OptimizationProblem< Real >::sol_.

Referenced by ROL::Step< Real >::compute(), ROL::Step< Real >::initialize(), ROL::Algorithm< Real >::run(), and ROL::Step< Real >::update().

setSolutionVector()

template<class Real>

void ROL::OptimizationProblem< Real >::setSolutionVector ( const Teuchos::RCP< Vector< Real > > &  sol )

inline

Definition at line 399 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::StochasticProblem< Real >::setSolutionStatistic(), and ROL::StochasticProblem< Real >::setSolutionVector().

getBoundConstraint()

template<class Real>

Teuchos::RCP<BoundConstraint<Real> > ROL::OptimizationProblem< Real >::getBoundConstraint ( void  )

inline

Definition at line 403 of file ROL_OptimizationProblem.hpp.

References ROL::OptimizationProblem< Real >::bnd_.

Referenced by ROL::Step< Real >::compute(), ROL::Step< Real >::initialize(), ROL::Algorithm< Real >::run(), and ROL::Step< Real >::update().

setBoundConstraint()

template<class Real>

void ROL::OptimizationProblem< Real >::setBoundConstraint ( const Teuchos::RCP< BoundConstraint< Real > > &  bnd )

inline

Definition at line 407 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::StochasticProblem< Real >::setBoundConstraint().

getEqualityConstraint()

template<class Real>

Teuchos::RCP<EqualityConstraint<Real> > ROL::OptimizationProblem< Real >::getEqualityConstraint ( void  )

inline

Definition at line 411 of file ROL_OptimizationProblem.hpp.

References ROL::OptimizationProblem< Real >::con_.

Referenced by ROL::Step< Real >::compute(), ROL::Step< Real >::initialize(), ROL::Algorithm< Real >::run(), and ROL::Step< Real >::update().

setEqualityConstraint()

template<class Real>

void ROL::OptimizationProblem< Real >::setEqualityConstraint ( const Teuchos::RCP< EqualityConstraint< Real > > &  con )

inline

Definition at line 415 of file ROL_OptimizationProblem.hpp.

getMultiplierVector()

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::OptimizationProblem< Real >::getMultiplierVector ( void  )

inline

Definition at line 419 of file ROL_OptimizationProblem.hpp.

References ROL::OptimizationProblem< Real >::mul_.

Referenced by ROL::Step< Real >::compute(), ROL::Step< Real >::initialize(), ROL::Algorithm< Real >::run(), and ROL::Step< Real >::update().

setMultiplierVector()

template<class Real>

void ROL::OptimizationProblem< Real >::setMultiplierVector ( const Teuchos::RCP< Vector< Real > > &  mul )

inline

Definition at line 423 of file ROL_OptimizationProblem.hpp.

getParameterList()

template<class Real>

Teuchos::RCP<Teuchos::ParameterList> ROL::OptimizationProblem< Real >::getParameterList ( void  )

inline

Definition at line 427 of file ROL_OptimizationProblem.hpp.

References ROL::OptimizationProblem< Real >::parlist_.

setParameterList()

template<class Real>

void ROL::OptimizationProblem< Real >::setParameterList ( const Teuchos::RCP< Teuchos::ParameterList > &  parlist )

inline

Definition at line 431 of file ROL_OptimizationProblem.hpp.

checkObjectiveGradient()

template<class Real>

virtual std::vector<std::vector<Real> > ROL::OptimizationProblem< Real >::checkObjectiveGradient ( const Vector< Real > &  d, const bool  printToStream = true, std::ostream &  outStream = std::cout, const int  numSteps = ROL_NUM_CHECKDERIV_STEPS, const int  order = 1  )

inlinevirtual

Reimplemented in ROL::StochasticProblem< Real >.

Definition at line 435 of file ROL_OptimizationProblem.hpp.

References ROL::RandomizeVector().

Referenced by ROL::StochasticProblem< Real >::checkObjectiveGradient().

checkObjectiveHessVec()

template<class Real>

virtual std::vector<std::vector<Real> > ROL::OptimizationProblem< Real >::checkObjectiveHessVec ( const Vector< Real > &  v, const bool  printToStream = true, std::ostream &  outStream = std::cout, const int  numSteps = ROL_NUM_CHECKDERIV_STEPS, const int  order = 1  )

inlinevirtual

Reimplemented in ROL::StochasticProblem< Real >.

Definition at line 451 of file ROL_OptimizationProblem.hpp.

References ROL::RandomizeVector().

Referenced by ROL::StochasticProblem< Real >::checkObjectiveHessVec().

Member Data Documentation

obj_

template<class Real>

Teuchos::RCP<Objective<Real> > ROL::OptimizationProblem< Real >::obj_

private

Definition at line 75 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::OptimizationProblem< Real >::getObjective().

sol_

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::OptimizationProblem< Real >::sol_

private

Definition at line 76 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::OptimizationProblem< Real >::getSolutionVector().

bnd_

template<class Real>

Teuchos::RCP<BoundConstraint<Real> > ROL::OptimizationProblem< Real >::bnd_

private

Definition at line 77 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::OptimizationProblem< Real >::getBoundConstraint().

con_

template<class Real>

Teuchos::RCP<EqualityConstraint<Real> > ROL::OptimizationProblem< Real >::con_

private

Definition at line 78 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::OptimizationProblem< Real >::getEqualityConstraint().

incon_

template<class Real>

Teuchos::RCP<InequalityConstraint<Real> > ROL::OptimizationProblem< Real >::incon_

private

Definition at line 79 of file ROL_OptimizationProblem.hpp.

mul_

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::OptimizationProblem< Real >::mul_

private

Definition at line 80 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::OptimizationProblem< Real >::getMultiplierVector().

parlist_

template<class Real>

Teuchos::RCP<Teuchos::ParameterList> ROL::OptimizationProblem< Real >::parlist_

private

Definition at line 81 of file ROL_OptimizationProblem.hpp.

Referenced by ROL::OptimizationProblem< Real >::getParameterList().

hasSlack_

template<class Real>

bool ROL::OptimizationProblem< Real >::hasSlack_

private

Definition at line 83 of file ROL_OptimizationProblem.hpp.

OPT

template<class Real>

const size_type ROL::OptimizationProblem< Real >::OPT = 0

staticprivate

Definition at line 85 of file ROL_OptimizationProblem.hpp.

SLACK

template<class Real>

const size_type ROL::OptimizationProblem< Real >::SLACK = 1

staticprivate

Definition at line 86 of file ROL_OptimizationProblem.hpp.

---

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

• ROL_OptimizationProblem.hpp