ROL
|
Provides an interface to run the Moreau-Yosida algorithm. More...
#include <ROL_TypeG_MoreauYosidaAlgorithm.hpp>
Public Member Functions | |
MoreauYosidaAlgorithm (ParameterList &list, const Ptr< Secant< Real >> &secant=nullPtr) | |
void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, std::ostream &outStream=std::cout) override |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
void | writeHeader (std::ostream &os) const override |
Print iterate header. More... | |
void | writeName (std::ostream &os) const override |
Print step name. More... | |
void | writeOutput (std::ostream &os, const bool print_header=false) const override |
Print iterate status. More... | |
Public Member Functions inherited from ROL::TypeG::Algorithm< Real > | |
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 general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G 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 > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, 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 general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G 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 > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, Constraint< Real > &econ, Vector< Real > &emul, const Vector< Real > &eres, Constraint< Real > &icon, Vector< Real > &imul, BoundConstraint< Real > &ibnd, const Vector< Real > &ires, Constraint< Real > &linear_econ, Vector< Real > &linear_emul, const Vector< Real > &linear_eres, std::ostream &outStream=std::cout) |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface. More... | |
virtual void | writeExitStatus (std::ostream &os) const |
Ptr< const AlgorithmState< Real > > | getState () const |
void | reset () |
Private Member Functions | |
void | initialize (Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &l, const Vector< Real > &c, MoreauYosidaObjective< Real > &myobj, BoundConstraint< Real > &bnd, Constraint< Real > &con, Vector< Real > &pwa, Vector< Real > &dwa, std::ostream &outStream=std::cout) |
void | updateState (const Vector< Real > &x, const Vector< Real > &l, MoreauYosidaObjective< Real > &myobj, BoundConstraint< Real > &bnd, Constraint< Real > &con, Vector< Real > &pwa, Vector< Real > &dwa, std::ostream &outStream=std::cout) |
Private Attributes | |
const Ptr< Secant< Real > > | secant_ |
Real | compViolation_ |
Real | gnorm_ |
Real | maxPenalty_ |
Real | tau_ |
bool | print_ |
bool | updatePenalty_ |
bool | updateMultiplier_ |
ROL::ParameterList | list_ |
int | subproblemIter_ |
std::string | stepname_ |
int | verbosity_ |
bool | printHeader_ |
bool | hasPolyProj_ |
Additional Inherited Members | |
Protected Member Functions inherited from ROL::TypeG::Algorithm< Real > | |
void | initialize (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &mul, const Vector< Real > &c) |
Protected Attributes inherited from ROL::TypeG::Algorithm< Real > | |
const Ptr< CombinedStatusTest < Real > > | status_ |
const Ptr< AlgorithmState< Real > > | state_ |
Ptr< PolyhedralProjection< Real > > | proj_ |
Provides an interface to run the Moreau-Yosida algorithm.
Definition at line 59 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm | ( | ParameterList & | list, |
const Ptr< Secant< Real >> & | secant = nullPtr |
||
) |
Definition at line 53 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
References ROL::TypeG::MoreauYosidaAlgorithm< Real >::list_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::maxPenalty_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::print_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::printHeader_, ROL::TypeG::Algorithm< Real >::state_, ROL::TypeG::Algorithm< Real >::status_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::stepname_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::tau_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::updateMultiplier_, ROL::TypeG::MoreauYosidaAlgorithm< Real >::updatePenalty_, and ROL::TypeG::MoreauYosidaAlgorithm< Real >::verbosity_.
|
private |
Definition at line 92 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
References ROL::TypeG::Algorithm< Real >::initialize().
|
private |
Definition at line 119 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
References ROL::Constraint< Real >::applyAdjointJacobian(), ROL::Vector< Real >::axpy(), ROL::MoreauYosidaObjective< Real >::getObjectiveGradient(), ROL::MoreauYosidaObjective< Real >::getObjectiveValue(), ROL::Initial, ROL::Vector< Real >::norm(), ROL::Vector< Real >::set(), ROL::MoreauYosidaObjective< Real >::testComplementarity(), ROL::Constraint< Real >::update(), ROL::MoreauYosidaObjective< Real >::update(), and ROL::Constraint< Real >::value().
|
overridevirtual |
Run algorithm on general constrained problems (Type-G). This is the primary Type-G interface.
Implements ROL::TypeG::Algorithm< Real >.
Definition at line 162 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
References ROL::Vector< Real >::clone(), ROL::MoreauYosidaObjective< Real >::updateMultipliers(), ROL::TypeG::Algorithm< Real >::writeExitStatus(), and ROL::Vector< Real >::zero().
|
overridevirtual |
Print iterate header.
Reimplemented from ROL::TypeG::Algorithm< Real >.
Definition at line 225 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
|
overridevirtual |
Print step name.
Reimplemented from ROL::TypeG::Algorithm< Real >.
Definition at line 262 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
|
overridevirtual |
Print iterate status.
Reimplemented from ROL::TypeG::Algorithm< Real >.
Definition at line 271 of file ROL_TypeG_MoreauYosidaAlgorithm_Def.hpp.
|
private |
Definition at line 61 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
|
private |
Definition at line 63 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
|
private |
Definition at line 64 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
|
private |
Definition at line 65 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 66 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 67 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 68 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 69 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 71 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 72 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
|
private |
Definition at line 74 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 76 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 77 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.
Referenced by ROL::TypeG::MoreauYosidaAlgorithm< Real >::MoreauYosidaAlgorithm().
|
private |
Definition at line 79 of file ROL_TypeG_MoreauYosidaAlgorithm.hpp.