ROL
|
#include <ROL_TypeE_Algorithm.hpp>
Public Member Functions | |
virtual | ~Algorithm () |
Algorithm () | |
Constructor, given a step and a status test. More... | |
void | setStatusTest (const Ptr< StatusTest< Real >> &status, bool combineStatus=false) |
virtual void | run (Problem< Real > &problem, std::ostream &outStream=std::cout) |
Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, std::ostream &outStream=std::cout) |
Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, std::ostream &outStream=std::cout)=0 |
Run algorithm on equality constrained problems (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout) |
Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This is the primary Type-E with explicit linear equality constraints interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout) |
Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method. More... | |
virtual void | writeHeader (std::ostream &os) const |
Print iterate header. More... | |
virtual void | writeName (std::ostream &os) const |
Print step name. More... | |
virtual void | writeOutput (std::ostream &os, const bool write_header=false) const |
Print iterate status. More... | |
virtual void | writeExitStatus (std::ostream &os) const |
Ptr< const AlgorithmState< Real > > | getState () const |
void | reset () |
Protected Member Functions | |
void | initialize (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &mul, const Vector< Real > &c) |
Protected Attributes | |
const Ptr< CombinedStatusTest < Real > > | status_ |
const Ptr< AlgorithmState< Real > > | state_ |
Definition at line 88 of file ROL_TypeE_Algorithm.hpp.
|
inlinevirtual |
Definition at line 100 of file ROL_TypeE_Algorithm.hpp.
ROL::TypeE::Algorithm< Real >::Algorithm | ( | ) |
Constructor, given a step and a status test.
Definition at line 56 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::TypeE::Algorithm< Real >::status_.
|
protected |
Definition at line 64 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::Vector< Real >::clone().
Referenced by ROL::TypeE::FletcherAlgorithm< Real >::initialize(), ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::initialize(), ROL::TypeE::StabilizedLCLAlgorithm< Real >::initialize(), and ROL::TypeE::CompositeStepAlgorithm< Real >::initialize().
void ROL::TypeE::Algorithm< Real >::setStatusTest | ( | const Ptr< StatusTest< Real >> & | status, |
bool | combineStatus = false |
||
) |
Definition at line 97 of file ROL_TypeE_Algorithm_Def.hpp.
|
virtual |
Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.
Reimplemented in ROL::TypeE::StabilizedLCLAlgorithm< Real >.
Definition at line 106 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::Problem< Real >::finalizeIteration(), ROL::Problem< Real >::getConstraint(), ROL::Problem< Real >::getDualOptimizationVector(), ROL::Problem< Real >::getMultiplierVector(), ROL::Problem< Real >::getObjective(), ROL::Problem< Real >::getPrimalOptimizationVector(), ROL::Problem< Real >::getProblemType(), ROL::Problem< Real >::getResidualVector(), and ROL::TYPE_E.
|
virtual |
Run algorithm on equality constrained problems (Type-E). This is the primary Type-E interface.
Definition at line 124 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::Problem< Real >::addConstraint(), and ROL::Problem< Real >::finalize().
|
pure virtual |
Run algorithm on equality constrained problems (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
Implemented in ROL::TypeE::CompositeStepAlgorithm< Real >, ROL::TypeE::StabilizedLCLAlgorithm< Real >, ROL::TypeE::AugmentedLagrangianAlgorithm< Real >, and ROL::TypeE::FletcherAlgorithm< Real >.
|
virtual |
Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This is the primary Type-E with explicit linear equality constraints interface.
Definition at line 137 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::Problem< Real >::addConstraint(), ROL::Problem< Real >::addLinearConstraint(), and ROL::Problem< Real >::finalize().
|
virtual |
Run algorithm on equality constrained problems with explicit linear equality constraints (Type-E). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.
Definition at line 153 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::Problem< Real >::addConstraint(), ROL::Problem< Real >::addLinearConstraint(), ROL::Vector< Real >::clone(), and ROL::Problem< Real >::finalize().
|
virtual |
Print iterate header.
Reimplemented in ROL::TypeE::CompositeStepAlgorithm< Real >, ROL::TypeE::StabilizedLCLAlgorithm< Real >, ROL::TypeE::AugmentedLagrangianAlgorithm< Real >, and ROL::TypeE::FletcherAlgorithm< Real >.
Definition at line 180 of file ROL_TypeE_Algorithm_Def.hpp.
|
virtual |
Print step name.
Reimplemented in ROL::TypeE::CompositeStepAlgorithm< Real >, ROL::TypeE::StabilizedLCLAlgorithm< Real >, ROL::TypeE::AugmentedLagrangianAlgorithm< Real >, and ROL::TypeE::FletcherAlgorithm< Real >.
Definition at line 195 of file ROL_TypeE_Algorithm_Def.hpp.
|
virtual |
Print iterate status.
Reimplemented in ROL::TypeE::CompositeStepAlgorithm< Real >, ROL::TypeE::StabilizedLCLAlgorithm< Real >, ROL::TypeE::AugmentedLagrangianAlgorithm< Real >, and ROL::TypeE::FletcherAlgorithm< Real >.
Definition at line 200 of file ROL_TypeE_Algorithm_Def.hpp.
|
virtual |
Definition at line 227 of file ROL_TypeE_Algorithm_Def.hpp.
References ROL::EExitStatusToString().
Referenced by ROL::TypeE::FletcherAlgorithm< Real >::run(), ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::run(), ROL::TypeE::StabilizedLCLAlgorithm< Real >::run(), and ROL::TypeE::CompositeStepAlgorithm< Real >::run().
Ptr< const AlgorithmState< Real > > ROL::TypeE::Algorithm< Real >::getState | ( | void | ) | const |
Definition at line 236 of file ROL_TypeE_Algorithm_Def.hpp.
void ROL::TypeE::Algorithm< Real >::reset | ( | void | ) |
Definition at line 242 of file ROL_TypeE_Algorithm_Def.hpp.
|
protected |
Definition at line 90 of file ROL_TypeE_Algorithm.hpp.
Referenced by ROL::TypeE::Algorithm< Real >::Algorithm(), ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::AugmentedLagrangianAlgorithm(), ROL::TypeE::CompositeStepAlgorithm< Real >::CompositeStepAlgorithm(), ROL::TypeE::FletcherAlgorithm< Real >::FletcherAlgorithm(), and ROL::TypeE::StabilizedLCLAlgorithm< Real >::StabilizedLCLAlgorithm().
|
protected |
Definition at line 91 of file ROL_TypeE_Algorithm.hpp.
Referenced by ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::AugmentedLagrangianAlgorithm(), and ROL::TypeE::StabilizedLCLAlgorithm< Real >::StabilizedLCLAlgorithm().