ROL
Public Member Functions | Private Types | Private Attributes | Static 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 (Teuchos::ParameterList &parlist)
 
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...
 
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...
 
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 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...
 
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...
 
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 void compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
 Compute step for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring. More...
 
virtual void update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
 Update step, for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring. 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 > &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 Teuchos::RCP< const StepState< Real > > getStepState (void) const
 Get state for step object. More...
 

Private Types

typedef InteriorPoint::PenalizedObjective< Real > IPOBJ
 
typedef InteriorPoint::CompositeConstraint< Real > IPCON
 
typedef PartitionedVector< Real > PV
 
typedef PV::size_type size_type
 

Private Attributes

Teuchos::RCP< StatusTest< Real > > status_
 
Teuchos::RCP< Step< Real > > step_
 
Teuchos::RCP< IPOBJipobj_
 
Teuchos::RCP< IPCONipcon_
 
Teuchos::RCP< Algorithm< Real > > algo_
 
Teuchos::RCP< Teuchos::ParameterList > parlist_
 
Teuchos::RCP< PVx_
 
Teuchos::RCP< Vector< Real > > g_
 
Teuchos::RCP< Vector< Real > > l_
 
Teuchos::RCP< Vector< Real > > c_
 
Real mu_
 
Real eps_
 
Real rho_
 
int maxit_
 
Real gtol_
 
Real ctol_
 
Real stol_
 
int subproblemIter_
 

Static Private Attributes

static const size_type OPT = 0
 
static const size_type SLACK = 1
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 57 of file ROL_InteriorPointStep.hpp.

Member Typedef Documentation

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

Definition at line 59 of file ROL_InteriorPointStep.hpp.

template<class Real >
typedef InteriorPoint::CompositeConstraint<Real> ROL::InteriorPointStep< Real >::IPCON
private

Definition at line 60 of file ROL_InteriorPointStep.hpp.

template<class Real >
typedef PartitionedVector<Real> ROL::InteriorPointStep< Real >::PV
private

Definition at line 62 of file ROL_InteriorPointStep.hpp.

template<class Real >
typedef PV::size_type ROL::InteriorPointStep< Real >::size_type
private

Definition at line 63 of file ROL_InteriorPointStep.hpp.

Constructor & Destructor Documentation

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

Definition at line 96 of file ROL_InteriorPointStep.hpp.

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

Definition at line 98 of file ROL_InteriorPointStep.hpp.

Member Function Documentation

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

Initialize step with equality constraint.

Reimplemented from ROL::Step< Real >.

Definition at line 181 of file ROL_InteriorPointStep.hpp.

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

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

Definition at line 192 of file ROL_InteriorPointStep.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::set().

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

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

Definition at line 211 of file ROL_InteriorPointStep.hpp.

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

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

Update step, if successful (equality constraints).

Reimplemented from ROL::Step< Real >.

Definition at line 278 of file ROL_InteriorPointStep.hpp.

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

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

Compute step for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring.

Implements ROL::Step< Real >.

Definition at line 290 of file ROL_InteriorPointStep.hpp.

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

Update step, for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring.

Implements ROL::Step< Real >.

Definition at line 297 of file ROL_InteriorPointStep.hpp.

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

Print iterate header.

Implements ROL::Step< Real >.

Definition at line 303 of file ROL_InteriorPointStep.hpp.

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

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

Print step name.

Implements ROL::Step< Real >.

Definition at line 323 of file ROL_InteriorPointStep.hpp.

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

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

Member Data Documentation

template<class Real >
const size_type ROL::InteriorPointStep< Real >::OPT = 0
staticprivate

Definition at line 65 of file ROL_InteriorPointStep.hpp.

template<class Real >
const size_type ROL::InteriorPointStep< Real >::SLACK = 1
staticprivate

Definition at line 66 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<StatusTest<Real> > ROL::InteriorPointStep< Real >::status_
private

Definition at line 70 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<Step<Real> > ROL::InteriorPointStep< Real >::step_
private

Definition at line 71 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<IPOBJ> ROL::InteriorPointStep< Real >::ipobj_
private

Definition at line 72 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<IPCON> ROL::InteriorPointStep< Real >::ipcon_
private

Definition at line 73 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<Algorithm<Real> > ROL::InteriorPointStep< Real >::algo_
private

Definition at line 74 of file ROL_InteriorPointStep.hpp.

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

Definition at line 75 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<PV> ROL::InteriorPointStep< Real >::x_
private

Definition at line 78 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::InteriorPointStep< Real >::g_
private

Definition at line 79 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::InteriorPointStep< Real >::l_
private

Definition at line 80 of file ROL_InteriorPointStep.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::InteriorPointStep< Real >::c_
private

Definition at line 81 of file ROL_InteriorPointStep.hpp.

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

Definition at line 83 of file ROL_InteriorPointStep.hpp.

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

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

Definition at line 84 of file ROL_InteriorPointStep.hpp.

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

Definition at line 85 of file ROL_InteriorPointStep.hpp.

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

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

Definition at line 86 of file ROL_InteriorPointStep.hpp.

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

Definition at line 89 of file ROL_InteriorPointStep.hpp.

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

Definition at line 90 of file ROL_InteriorPointStep.hpp.

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

Definition at line 91 of file ROL_InteriorPointStep.hpp.

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

Definition at line 92 of file ROL_InteriorPointStep.hpp.

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


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