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

Provides the interface to compute optimization steps. More...

#include <ROL_Step.hpp>

+ Inheritance diagram for ROL::Step< Real >:

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_
 

Detailed Description

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

Provides the interface to compute optimization steps.

Definition at line 67 of file ROL_Step.hpp.

Constructor & Destructor Documentation

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

Definition at line 78 of file ROL_Step.hpp.

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

Definition at line 80 of file ROL_Step.hpp.

Member Function Documentation

template<class Real >
Teuchos::RCP<StepState<Real> > ROL::Step< Real >::getState ( void  )
inlineprotected
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.

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().

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
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,
EqualityConstraint< Real > &  con,
AlgorithmState< Real > &  algo_state 
)
inlinevirtual

Initialize step with equality constraint.

Reimplemented in ROL::CompositeStep< Real >, and ROL::InteriorPointStep< Real >.

Definition at line 128 of file ROL_Step.hpp.

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,
EqualityConstraint< Real > &  con,
BoundConstraint< Real > &  bnd,
AlgorithmState< Real > &  algo_state 
)
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().

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

Compute step (equality constraints).

Reimplemented in ROL::CompositeStep< Real >, and ROL::InteriorPointStep< Real >.

Definition at line 154 of file ROL_Step.hpp.

template<class Real >
virtual void ROL::Step< Real >::update ( Vector< Real > &  x,
Vector< Real > &  l,
const Vector< Real > &  s,
Objective< Real > &  obj,
EqualityConstraint< Real > &  con,
AlgorithmState< Real > &  algo_state 
)
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.

template<class Real >
virtual void ROL::Step< Real >::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 
)
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.

template<class Real >
virtual void ROL::Step< Real >::update ( Vector< Real > &  x,
Vector< Real > &  l,
const Vector< Real > &  s,
Objective< Real > &  obj,
EqualityConstraint< Real > &  con,
BoundConstraint< Real > &  bnd,
AlgorithmState< Real > &  algo_state 
)
inlinevirtual
template<class Real >
virtual std::string ROL::Step< Real >::printHeader ( void  ) const
pure virtual
template<class Real >
virtual std::string ROL::Step< Real >::printName ( void  ) const
pure virtual
template<class Real >
virtual std::string ROL::Step< Real >::print ( AlgorithmState< Real > &  algo_state,
bool  printHeader = false 
) const
pure virtual
template<class Real >
virtual Teuchos::RCP<const StepState<Real> > ROL::Step< Real >::getStepState ( void  ) const
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().

Member Data Documentation

template<class Real >
Teuchos::RCP<StepState<Real> > ROL::Step< Real >::state_
private

Definition at line 69 of file ROL_Step.hpp.

Referenced by ROL::Step< Real >::getState(), and ROL::Step< Real >::getStepState().


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