ROL
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ROL::Step< Real > Class Template Reference
Optimization Steps

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.
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.
virtual void initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, Constraint< Real > &con, AlgorithmState< Real > &algo_state)
 Initialize step with equality constraint.
virtual void initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Initialize step with equality constraint.
virtual void compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Compute step.
virtual void update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Update step, if successful.
virtual void compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, Constraint< Real > &con, AlgorithmState< Real > &algo_state)
 Compute step (equality constraints).
virtual void update (Vector< Real > &x, Vector< Real > &l, const Vector< Real > &s, Objective< Real > &obj, Constraint< Real > &con, AlgorithmState< Real > &algo_state)
 Update step, if successful (equality constraints).
virtual void compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Compute step (equality constraints).
virtual void update (Vector< Real > &x, Vector< Real > &l, const Vector< Real > &s, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Update step, if successful (equality constraints).
virtual std::string printHeader (void) const
 Print iterate header.
virtual std::string printName (void) const
 Print step name.
virtual std::string print (AlgorithmState< Real > &algo_state, bool printHeader=false) const
 Print iterate status.
const ROL::Ptr< const StepState< Real > > getStepState (void) const
 Get state for step object.
void reset (const Real searchSize=1.0)
 Get state for step object.

Protected Member Functions

ROL::Ptr< StepState< Real > > getState (void)

Private Attributes

ROL::Ptr< StepState< Real > > state_

Detailed Description

template<class Real>
class ROL::Step< Real >

Provides the interface to compute optimization steps.

Definition at line 68 of file ROL_Step.hpp.

Constructor & Destructor Documentation

◆ ~Step()

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

Definition at line 79 of file ROL_Step.hpp.

◆ Step()

template<class Real>
ROL::Step< Real >::Step ( void )
inline

Definition at line 81 of file ROL_Step.hpp.

References state_.

Member Function Documentation

◆ getState()

template<class Real>
ROL::Ptr< StepState< Real > > ROL::Step< Real >::getState ( void )
inlineprotected

Definition at line 73 of file ROL_Step.hpp.

References state_.

Referenced by ROL::AugmentedLagrangianStep< Real >::AugmentedLagrangianStep(), ROL::BundleStep< Real >::BundleStep(), ROL::BundleStep< Real >::compute(), ROL::GradientStep< Real >::compute(), ROL::InteriorPointStep< Real >::compute(), ROL::LineSearchStep< Real >::compute(), ROL::MoreauYosidaPenaltyStep< Real >::compute(), ROL::NewtonKrylovStep< Real >::compute(), ROL::NewtonStep< Real >::compute(), ROL::NonlinearCGStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), ROL::PrimalDualSystemStep< Real >::compute(), ROL::ProjectedNewtonKrylovStep< Real >::compute(), ROL::ProjectedNewtonStep< Real >::compute(), ROL::ProjectedSecantStep< Real >::compute(), ROL::SecantStep< Real >::compute(), ROL::TrustRegionStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::computeCriticalityMeasure(), ROL::FletcherStep< Real >::FletcherStep(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::BundleStep< Real >::initialize(), ROL::CompositeStep< Real >::initialize(), ROL::FletcherStep< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::MoreauYosidaPenaltyStep(), ROL::TrustRegionStep< Real >::parseParameterList(), ROL::AugmentedLagrangianStep< Real >::update(), ROL::BundleStep< Real >::update(), ROL::CompositeStep< Real >::update(), ROL::FletcherStep< Real >::update(), ROL::GradientStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), ROL::LineSearchStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::MoreauYosidaPenaltyStep< Real >::update(), ROL::NewtonKrylovStep< Real >::update(), ROL::NewtonStep< Real >::update(), ROL::NonlinearCGStep< Real >::update(), ROL::PrimalDualActiveSetStep< Real >::update(), ROL::PrimalDualSystemStep< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::ProjectedNewtonStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::SecantStep< Real >::update(), ROL::TrustRegionStep< Real >::update(), ROL::TrustRegionStep< Real >::updateGradient(), ROL::MoreauYosidaPenaltyStep< Real >::updateState(), and ROL::MoreauYosidaPenaltyStep< Real >::updateState().

◆ initialize() [1/4]

template<class Real>
virtual void ROL::Step< Real >::initialize ( Vector< Real > & x,
const Vector< Real > & g,
Objective< Real > & obj,
BoundConstraint< Real > & con,
AlgorithmState< Real > & algo_state )
inlinevirtual

Initialize step with bound constraint.

Definition at line 88 of file ROL_Step.hpp.

References initialize().

Referenced by ROL::BundleStep< Real >::initialize(), ROL::NewtonKrylovStep< Real >::initialize(), ROL::PrimalDualSystemStep< Real >::initialize(), ROL::ProjectedNewtonKrylovStep< Real >::initialize(), ROL::ProjectedNewtonStep< Real >::initialize(), ROL::ProjectedSecantStep< Real >::initialize(), ROL::SecantStep< Real >::initialize(), and initialize().

◆ initialize() [2/4]

template<class Real>
virtual void ROL::Step< Real >::initialize ( Vector< Real > & x,
const Vector< Real > & s,
const Vector< Real > & g,
Objective< Real > & obj,
BoundConstraint< Real > & con,
AlgorithmState< Real > & algo_state )
inlinevirtual

Initialize step with bound constraint.

Definition at line 96 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(), state_, ROL::Objective< Real >::update(), ROL::AlgorithmState< Real >::value, ROL::Objective< Real >::value(), and zero.

◆ initialize() [3/4]

template<class Real>
virtual void ROL::Step< Real >::initialize ( Vector< Real > & x,
const Vector< Real > & g,
Vector< Real > & l,
const Vector< Real > & c,
Objective< Real > & obj,
Constraint< Real > & con,
AlgorithmState< Real > & algo_state )
inlinevirtual

Initialize step with equality constraint.

Definition at line 129 of file ROL_Step.hpp.

◆ initialize() [4/4]

template<class Real>
virtual void ROL::Step< Real >::initialize ( Vector< Real > & x,
const Vector< Real > & g,
Vector< Real > & l,
const Vector< Real > & c,
Objective< Real > & obj,
Constraint< Real > & con,
BoundConstraint< Real > & bnd,
AlgorithmState< Real > & algo_state )
inlinevirtual

Initialize step with equality constraint.

Definition at line 136 of file ROL_Step.hpp.

◆ compute() [1/3]

template<class Real>
virtual void ROL::Step< Real >::compute ( Vector< Real > & s,
const Vector< Real > & x,
Objective< Real > & obj,
BoundConstraint< Real > & bnd,
AlgorithmState< Real > & algo_state )
inlinevirtual

Compute step.

Definition at line 143 of file ROL_Step.hpp.

Referenced by main().

◆ update() [1/3]

template<class Real>
virtual void ROL::Step< Real >::update ( Vector< Real > & x,
const Vector< Real > & s,
Objective< Real > & obj,
BoundConstraint< Real > & bnd,
AlgorithmState< Real > & algo_state )
inlinevirtual

Update step, if successful.

Definition at line 151 of file ROL_Step.hpp.

Referenced by main().

◆ compute() [2/3]

template<class Real>
virtual void ROL::Step< Real >::compute ( Vector< Real > & s,
const Vector< Real > & x,
const Vector< Real > & l,
Objective< Real > & obj,
Constraint< Real > & con,
AlgorithmState< Real > & algo_state )
inlinevirtual

Compute step (equality constraints).

Definition at line 159 of file ROL_Step.hpp.

◆ update() [2/3]

template<class Real>
virtual void ROL::Step< Real >::update ( Vector< Real > & x,
Vector< Real > & l,
const Vector< Real > & s,
Objective< Real > & obj,
Constraint< Real > & con,
AlgorithmState< Real > & algo_state )
inlinevirtual

Update step, if successful (equality constraints).

Definition at line 167 of file ROL_Step.hpp.

◆ compute() [3/3]

template<class Real>
virtual void ROL::Step< Real >::compute ( Vector< Real > & s,
const Vector< Real > & x,
const Vector< Real > & l,
Objective< Real > & obj,
Constraint< Real > & con,
BoundConstraint< Real > & bnd,
AlgorithmState< Real > & algo_state )
inlinevirtual

Compute step (equality constraints).

Definition at line 175 of file ROL_Step.hpp.

◆ update() [3/3]

template<class Real>
virtual void ROL::Step< Real >::update ( Vector< Real > & x,
Vector< Real > & l,
const Vector< Real > & s,
Objective< Real > & obj,
Constraint< Real > & con,
BoundConstraint< Real > & bnd,
AlgorithmState< Real > & algo_state )
inlinevirtual

Update step, if successful (equality constraints).

Definition at line 184 of file ROL_Step.hpp.

◆ printHeader()

template<class Real>
virtual std::string ROL::Step< Real >::printHeader ( void ) const
inlinevirtual

Print iterate header.

Definition at line 193 of file ROL_Step.hpp.

Referenced by main(), and print().

◆ printName()

template<class Real>
virtual std::string ROL::Step< Real >::printName ( void ) const
inlinevirtual

Print step name.

Definition at line 199 of file ROL_Step.hpp.

Referenced by main().

◆ print()

template<class Real>
virtual std::string ROL::Step< Real >::print ( AlgorithmState< Real > & algo_state,
bool printHeader = false ) const
inlinevirtual

Print iterate status.

Definition at line 205 of file ROL_Step.hpp.

References printHeader().

Referenced by main().

◆ getStepState()

template<class Real>
const ROL::Ptr< const StepState< Real > > ROL::Step< Real >::getStepState ( void ) const
inline

Get state for step object.

Definition at line 211 of file ROL_Step.hpp.

References state_.

Referenced by ROL::BundleStep< Real >::print(), ROL::FletcherStep< Real >::print(), ROL::LineSearchStep< Real >::print(), ROL::TrustRegionStep< Real >::print(), and ROL::FletcherStep< Real >::update().

◆ reset()

template<class Real>
void ROL::Step< Real >::reset ( const Real searchSize = 1.0)
inline

Get state for step object.

Definition at line 217 of file ROL_Step.hpp.

References state_.

Member Data Documentation

◆ state_

template<class Real>
ROL::Ptr<StepState<Real> > ROL::Step< Real >::state_
private

Definition at line 70 of file ROL_Step.hpp.

Referenced by getState(), getStepState(), initialize(), reset(), and Step().

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0