ROL
Public Member Functions | Private Types | Private Attributes | List of all members
ROL::InteriorPointStep< Real > Class Template Reference

#include <ROL_InteriorPointStep.hpp>

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

Public Member Functions

 ~InteriorPointStep ()
 
 InteriorPointStep (ROL::ParameterList &parlist)
 
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. More...
 
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. More...
 
void initialize (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Initialize step with no equality constraint. More...
 
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). More...
 
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). More...
 
void compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Compute step. More...
 
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). More...
 
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). More...
 
void update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
 Update step, if successful. More...
 
std::string printHeader (void) const
 Print iterate header. More...
 
std::string printName (void) const
 Print step name. More...
 
std::string print (AlgorithmState< Real > &algo_state, bool pHeader=false) const
 Print iterate status. More...
 
- Public Member Functions inherited from ROL::Step< Real >
virtual ~Step ()
 
 Step (void)
 
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...
 
void initialize (OptimizationProblem< Real > &opt, AlgorithmState< Real > &algo_state)
 
void compute (Vector< Real > &s, OptimizationProblem< Real > &opt, AlgorithmState< Real > &algo_state)
 
void update (OptimizationProblem< Real > &opt, const Vector< Real > &s, AlgorithmState< Real > &algo_state)
 
const ROL::Ptr< const StepState< Real > > getStepState (void) const
 Get state for step object. More...
 
void reset (const Real searchSize=1.0)
 Get state for step object. More...
 

Private Types

typedef InteriorPoint::PenalizedObjective< Real > IPOBJ
 
typedef Constraint_Partitioned< Real > IPCON
 

Private Attributes

ROL::Ptr< StatusTest< Real > > status_
 
ROL::Ptr< Step< Real > > step_
 
ROL::Ptr< Algorithm< Real > > algo_
 
ROL::Ptr< BoundConstraint< Real > > bnd_
 
ROL::ParameterList parlist_
 
ROL::Ptr< Vector< Real > > x_
 
ROL::Ptr< Vector< Real > > g_
 
ROL::Ptr< Vector< Real > > l_
 
ROL::Ptr< Vector< Real > > c_
 
Real mu_
 
Real mumin_
 
Real mumax_
 
Real rho_
 
int subproblemIter_
 
int verbosity_
 
bool print_
 
bool hasEquality_
 
EStep stepType_
 
std::string stepname_
 

Additional Inherited Members

- Protected Member Functions inherited from ROL::Step< Real >
ROL::Ptr< StepState< Real > > getState (void)
 

Detailed Description

template<class Real>
class ROL::InteriorPointStep< Real >

Definition at line 58 of file ROL_InteriorPointStep.hpp.

Member Typedef Documentation

◆ IPOBJ

template<class Real >
typedef InteriorPoint::PenalizedObjective<Real> ROL::InteriorPointStep< Real >::IPOBJ
private

Definition at line 60 of file ROL_InteriorPointStep.hpp.

◆ IPCON

template<class Real >
typedef Constraint_Partitioned<Real> ROL::InteriorPointStep< Real >::IPCON
private

Definition at line 61 of file ROL_InteriorPointStep.hpp.

Constructor & Destructor Documentation

◆ ~InteriorPointStep()

template<class Real >
ROL::InteriorPointStep< Real >::~InteriorPointStep ( )
inline

Definition at line 99 of file ROL_InteriorPointStep.hpp.

◆ InteriorPointStep()

template<class Real >
ROL::InteriorPointStep< Real >::InteriorPointStep ( ROL::ParameterList &  parlist)
inline

Member Function Documentation

◆ initialize() [1/3]

template<class Real >
void ROL::InteriorPointStep< 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() [2/3]

template<class Real >
void ROL::InteriorPointStep< 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.

Reimplemented from ROL::Step< Real >.

Definition at line 190 of file ROL_InteriorPointStep.hpp.

References ROL::InteriorPointStep< Real >::initialize(), and ROL::BoundConstraint< Real >::projectInterior().

◆ initialize() [3/3]

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

◆ compute() [1/3]

template<class Real >
void ROL::InteriorPointStep< 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() [2/3]

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

Reimplemented from ROL::Step< Real >.

Definition at line 283 of file ROL_InteriorPointStep.hpp.

References ROL::InteriorPointStep< Real >::compute().

◆ compute() [3/3]

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

◆ update() [1/3]

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

◆ update() [2/3]

template<class Real >
void ROL::InteriorPointStep< 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() [3/3]

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

◆ printHeader()

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

◆ printName()

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

Print step name.

Reimplemented from ROL::Step< Real >.

Definition at line 485 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::print().

◆ print()

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

Member Data Documentation

◆ status_

template<class Real >
ROL::Ptr<StatusTest<Real> > ROL::InteriorPointStep< Real >::status_
private

Definition at line 65 of file ROL_InteriorPointStep.hpp.

◆ step_

template<class Real >
ROL::Ptr<Step<Real> > ROL::InteriorPointStep< Real >::step_
private

Definition at line 66 of file ROL_InteriorPointStep.hpp.

◆ algo_

template<class Real >
ROL::Ptr<Algorithm<Real> > ROL::InteriorPointStep< Real >::algo_
private

Definition at line 67 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::compute().

◆ bnd_

template<class Real >
ROL::Ptr<BoundConstraint<Real> > ROL::InteriorPointStep< Real >::bnd_
private

◆ parlist_

template<class Real >
ROL::ParameterList ROL::InteriorPointStep< Real >::parlist_
private

◆ x_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::InteriorPointStep< Real >::x_
private

◆ g_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::InteriorPointStep< Real >::g_
private

◆ l_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::InteriorPointStep< Real >::l_
private

◆ c_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::InteriorPointStep< Real >::c_
private

◆ mu_

template<class Real >
Real ROL::InteriorPointStep< Real >::mu_
private

◆ mumin_

template<class Real >
Real ROL::InteriorPointStep< Real >::mumin_
private

◆ mumax_

template<class Real >
Real ROL::InteriorPointStep< Real >::mumax_
private

◆ rho_

template<class Real >
Real ROL::InteriorPointStep< Real >::rho_
private

◆ subproblemIter_

template<class Real >
int ROL::InteriorPointStep< Real >::subproblemIter_
private

◆ verbosity_

template<class Real >
int ROL::InteriorPointStep< Real >::verbosity_
private

◆ print_

template<class Real >
bool ROL::InteriorPointStep< Real >::print_
private

◆ hasEquality_

template<class Real >
bool ROL::InteriorPointStep< Real >::hasEquality_
private

◆ stepType_

template<class Real >
EStep ROL::InteriorPointStep< Real >::stepType_
private

◆ stepname_

template<class Real >
std::string ROL::InteriorPointStep< Real >::stepname_
private

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