ROL
|
Provides the interface to compute optimization steps. More...
#include <ROL_Step.hpp>
Public Member Functions | |
virtual | ~Step () |
Step (void) | |
virtual void | initialize (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state) |
Initialize step with bound constraint. More... | |
virtual void | initialize (Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state) |
Initialize step with bound constraint. More... | |
virtual void | initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, EqualityConstraint< Real > &con, AlgorithmState< Real > &algo_state) |
Initialize step with equality constraint. More... | |
virtual void | initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state) |
Initialize step with equality constraint. More... | |
virtual void | compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)=0 |
Compute step. More... | |
virtual void | update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)=0 |
Update step, if successful. More... | |
virtual void | compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, EqualityConstraint< Real > &con, AlgorithmState< Real > &algo_state) |
Compute step (equality constraints). More... | |
virtual void | update (Vector< Real > &x, Vector< Real > &l, const Vector< Real > &s, Objective< Real > &obj, EqualityConstraint< Real > &con, AlgorithmState< Real > &algo_state) |
Update step, if successful (equality constraints). More... | |
virtual void | compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state) |
Compute step (equality constraints). More... | |
virtual void | update (Vector< Real > &x, Vector< Real > &l, const Vector< Real > &s, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state) |
Update step, if successful (equality constraints). More... | |
virtual std::string | printHeader (void) const =0 |
Print iterate header. More... | |
virtual std::string | printName (void) const =0 |
Print step name. More... | |
virtual std::string | print (AlgorithmState< Real > &algo_state, bool printHeader=false) const =0 |
Print iterate status. More... | |
virtual Teuchos::RCP< const StepState< Real > > | getStepState (void) const |
Get state for step object. More... | |
Protected Member Functions | |
Teuchos::RCP< StepState< Real > > | getState (void) |
Private Attributes | |
Teuchos::RCP< StepState< Real > > | state_ |
Provides the interface to compute optimization steps.
Definition at line 67 of file ROL_Step.hpp.
Definition at line 78 of file ROL_Step.hpp.
Definition at line 80 of file ROL_Step.hpp.
|
inlineprotected |
Definition at line 72 of file ROL_Step.hpp.
References ROL::Step< Real >::state_.
Referenced by ROL::AugmentedLagrangianStep< Real >::AugmentedLagrangianStep(), ROL::BundleStep< Real >::BundleStep(), ROL::BundleStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), ROL::TrustRegionStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::computeCriticalityMeasure(), ROL::InteriorPointStep< Real >::initialize(), ROL::BundleStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::LineSearchStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::MoreauYosidaPenaltyStep(), ROL::TrustRegionStep< Real >::TrustRegionStep(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().
|
inlinevirtual |
Initialize step with bound constraint.
Reimplemented in ROL::BundleStep< Real >.
Definition at line 87 of file ROL_Step.hpp.
Referenced by ROL::BundleStep< Real >::initialize(), and ROL::LineSearchStep< Real >::initialize().
|
inlinevirtual |
Initialize step with bound constraint.
Reimplemented in ROL::LineSearchStep< Real >, ROL::TrustRegionStep< Real >, and ROL::PrimalDualActiveSetStep< Real >.
Definition at line 95 of file ROL_Step.hpp.
References ROL::Vector< Real >::clone(), ROL::AlgorithmState< Real >::gnorm, ROL::Objective< Real >::gradient(), ROL::BoundConstraint< Real >::isActivated(), ROL::AlgorithmState< Real >::iter, ROL::AlgorithmState< Real >::nfval, ROL::AlgorithmState< Real >::ngrad, ROL::BoundConstraint< Real >::project(), ROL::ROL_EPSILON, ROL::Objective< Real >::update(), ROL::AlgorithmState< Real >::value, and ROL::Objective< Real >::value().
|
inlinevirtual |
Initialize step with equality constraint.
Reimplemented in ROL::CompositeStep< Real >, and ROL::InteriorPointStep< Real >.
Definition at line 128 of file ROL_Step.hpp.
|
inlinevirtual |
Initialize step with equality constraint.
Reimplemented in ROL::MoreauYosidaPenaltyStep< Real >, ROL::InteriorPointStep< Real >, and ROL::AugmentedLagrangianStep< Real >.
Definition at line 135 of file ROL_Step.hpp.
References ROL::Step< Real >::compute(), and ROL::Step< Real >::update().
|
pure virtual |
Compute step.
Implemented in ROL::LineSearchStep< Real >, ROL::TrustRegionStep< Real >, ROL::CompositeStep< Real >, ROL::AugmentedLagrangianStep< Real >, ROL::MoreauYosidaPenaltyStep< Real >, ROL::PrimalDualActiveSetStep< Real >, ROL::InteriorPointStep< Real >, and ROL::BundleStep< Real >.
Referenced by ROL::Step< Real >::initialize().
|
pure virtual |
Update step, if successful.
Implemented in ROL::LineSearchStep< Real >, ROL::TrustRegionStep< Real >, ROL::PrimalDualActiveSetStep< Real >, ROL::CompositeStep< Real >, ROL::AugmentedLagrangianStep< Real >, ROL::MoreauYosidaPenaltyStep< Real >, ROL::BundleStep< Real >, and ROL::InteriorPointStep< Real >.
Referenced by ROL::Step< Real >::initialize().
|
inlinevirtual |
Compute step (equality constraints).
Reimplemented in ROL::CompositeStep< Real >, and ROL::InteriorPointStep< Real >.
Definition at line 154 of file ROL_Step.hpp.
|
inlinevirtual |
Update step, if successful (equality constraints).
Reimplemented in ROL::CompositeStep< Real >, and ROL::InteriorPointStep< Real >.
Definition at line 160 of file ROL_Step.hpp.
|
inlinevirtual |
Compute step (equality constraints).
Reimplemented in ROL::MoreauYosidaPenaltyStep< Real >, ROL::InteriorPointStep< Real >, and ROL::AugmentedLagrangianStep< Real >.
Definition at line 166 of file ROL_Step.hpp.
|
inlinevirtual |
Update step, if successful (equality constraints).
Reimplemented in ROL::InteriorPointStep< Real >, ROL::MoreauYosidaPenaltyStep< Real >, and ROL::AugmentedLagrangianStep< Real >.
Definition at line 173 of file ROL_Step.hpp.
References ROL::Step< Real >::print(), ROL::Step< Real >::printHeader(), and ROL::Step< Real >::printName().
|
pure virtual |
Print iterate header.
Implemented in ROL::LineSearchStep< Real >, ROL::TrustRegionStep< Real >, ROL::PrimalDualActiveSetStep< Real >, ROL::CompositeStep< Real >, ROL::BundleStep< Real >, ROL::InteriorPointStep< Real >, ROL::AugmentedLagrangianStep< Real >, and ROL::MoreauYosidaPenaltyStep< Real >.
Referenced by ROL::Step< Real >::update().
|
pure virtual |
Print step name.
Implemented in ROL::LineSearchStep< Real >, ROL::TrustRegionStep< Real >, ROL::PrimalDualActiveSetStep< Real >, ROL::CompositeStep< Real >, ROL::BundleStep< Real >, ROL::InteriorPointStep< Real >, ROL::AugmentedLagrangianStep< Real >, and ROL::MoreauYosidaPenaltyStep< Real >.
Referenced by ROL::Step< Real >::update().
|
pure virtual |
Print iterate status.
Implemented in ROL::LineSearchStep< Real >, ROL::TrustRegionStep< Real >, ROL::PrimalDualActiveSetStep< Real >, ROL::CompositeStep< Real >, ROL::BundleStep< Real >, ROL::InteriorPointStep< Real >, ROL::AugmentedLagrangianStep< Real >, and ROL::MoreauYosidaPenaltyStep< Real >.
Referenced by ROL::Step< Real >::update().
|
inlinevirtual |
Get state for step object.
Definition at line 192 of file ROL_Step.hpp.
References ROL::Step< Real >::state_.
Referenced by ROL::BundleStep< Real >::print(), and ROL::TrustRegionStep< Real >::print().
Definition at line 69 of file ROL_Step.hpp.
Referenced by ROL::Step< Real >::getState(), and ROL::Step< Real >::getStepState().