ROL
Public Member Functions | Private Attributes | List of all members
ROL::DefaultAlgorithm< Real > Class Template Reference

#include <ROL_Algorithm.hpp>

Public Member Functions

virtual ~DefaultAlgorithm ()
 
 DefaultAlgorithm (Step< Real > &step, StatusTest< Real > &status, bool printHeader=false)
 
 DefaultAlgorithm (Step< Real > &step, StatusTest< Real > &status, AlgorithmState< Real > &state, bool printHeader=false)
 
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, 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 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...
 
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::DefaultAlgorithm< Real >

Definition at line 62 of file ROL_Algorithm.hpp.

Constructor & Destructor Documentation

template<class Real>
virtual ROL::DefaultAlgorithm< Real >::~DefaultAlgorithm ( )
inlinevirtual

Definition at line 72 of file ROL_Algorithm.hpp.

template<class Real>
ROL::DefaultAlgorithm< Real >::DefaultAlgorithm ( Step< Real > &  step,
StatusTest< Real > &  status,
bool  printHeader = false 
)
inline
template<class Real>
ROL::DefaultAlgorithm< Real >::DefaultAlgorithm ( Step< Real > &  step,
StatusTest< Real > &  status,
AlgorithmState< Real > &  state,
bool  printHeader = false 
)
inline

Member Function Documentation

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 92 of file ROL_Algorithm.hpp.

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

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

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 105 of file ROL_Algorithm.hpp.

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

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 118 of file ROL_Algorithm.hpp.

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

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 130 of file ROL_Algorithm.hpp.

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

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 185 of file ROL_Algorithm.hpp.

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

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 201 of file ROL_Algorithm.hpp.

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

template<class Real>
virtual std::vector<std::string> ROL::DefaultAlgorithm< 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 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 249 of file ROL_Algorithm.hpp.

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

template<class Real>
std::string ROL::DefaultAlgorithm< Real >::getIterHeader ( void  )
inline

Definition at line 294 of file ROL_Algorithm.hpp.

References ROL::DefaultAlgorithm< Real >::step_.

template<class Real>
std::string ROL::DefaultAlgorithm< Real >::getIterInfo ( bool  withHeader = false)
inline
template<class Real>
Teuchos::RCP<const AlgorithmState<Real> > ROL::DefaultAlgorithm< Real >::getState ( void  ) const
inline

Definition at line 302 of file ROL_Algorithm.hpp.

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

Referenced by main().

Member Data Documentation

template<class Real>
Teuchos::RCP<Step<Real> > ROL::DefaultAlgorithm< Real >::step_
private
template<class Real>
Teuchos::RCP<StatusTest<Real> > ROL::DefaultAlgorithm< Real >::status_
private
template<class Real>
Teuchos::RCP<AlgorithmState<Real> > ROL::DefaultAlgorithm< Real >::state_
private
template<class Real>
bool ROL::DefaultAlgorithm< Real >::printHeader_
private

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