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

Provides the interface to compute bundle trust-region steps. More...

#include <ROL_BundleStep.hpp>

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

Public Member Functions

 BundleStep (ROL::ParameterList &parlist)
 
void initialize (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
 Initialize step with bound constraint.
 
void compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
 Compute step.
 
void update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
 Update step, if successful.
 
std::string printHeader (void) const
 Print iterate header.
 
std::string printName (void) const
 Print step name.
 
std::string print (AlgorithmState< Real > &algo_state, bool print_header=false) const
 Print iterate status.
 
- 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.
 
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, 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).
 
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.
 

Private Attributes

ROL::Ptr< Bundle< Real > > bundle_
 
ROL::Ptr< LineSearch< Real > > lineSearch_
 
unsigned QPiter_
 
unsigned QPmaxit_
 
Real QPtol_
 
int step_flag_
 
ROL::Ptr< Vector< Real > > y_
 
Real linErrNew_
 
Real valueNew_
 
ROL::Ptr< Vector< Real > > aggSubGradNew_
 
Real aggSubGradOldNorm_
 
Real aggLinErrNew_
 
Real aggLinErrOld_
 
Real aggDistMeasNew_
 
Real T_
 
Real tol_
 
Real m1_
 
Real m2_
 
Real m3_
 
Real nu_
 
int ls_maxit_
 
bool first_print_
 
bool isConvex_
 
Real ftol_
 
int verbosity_
 

Additional Inherited Members

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

Detailed Description

template<class Real>
class ROL::BundleStep< Real >

Provides the interface to compute bundle trust-region steps.

Definition at line 67 of file ROL_BundleStep.hpp.

Constructor & Destructor Documentation

◆ BundleStep()

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

Member Function Documentation

◆ initialize()

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

◆ compute()

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

Compute step.

Reimplemented from ROL::Step< Real >.

Definition at line 188 of file ROL_BundleStep.hpp.

References ROL::BundleStep< Real >::aggDistMeasNew_, ROL::BundleStep< Real >::aggLinErrNew_, ROL::BundleStep< Real >::aggLinErrOld_, ROL::AlgorithmState< Real >::aggregateGradientNorm, ROL::AlgorithmState< Real >::aggregateModelError, ROL::BundleStep< Real >::aggSubGradNew_, ROL::BundleStep< Real >::aggSubGradOldNorm_, ROL::BundleStep< Real >::bundle_, ROL::Vector< Real >::dot(), ROL::BundleStep< Real >::first_print_, ROL::AlgorithmState< Real >::flag, ROL::BundleStep< Real >::ftol_, ROL::Step< Real >::getState(), ROL::Objective< Real >::gradient(), ROL::BundleStep< Real >::isConvex_, ROL::AlgorithmState< Real >::iter, ROL::BundleStep< Real >::linErrNew_, ROL::BundleStep< Real >::lineSearch_, ROL::BundleStep< Real >::ls_maxit_, ROL::BundleStep< Real >::m1_, ROL::BundleStep< Real >::m2_, ROL::BundleStep< Real >::m3_, ROL::AlgorithmState< Real >::nfval, ROL::AlgorithmState< Real >::ngrad, ROL::BundleStep< Real >::nu_, ROL::BundleStep< Real >::QPiter_, ROL::BundleStep< Real >::QPmaxit_, ROL::BundleStep< Real >::QPtol_, ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), ROL::AlgorithmState< Real >::snorm, ROL::BundleStep< Real >::step_flag_, ROL::BundleStep< Real >::T_, ROL::BundleStep< Real >::tol_, ROL::Objective< Real >::update(), ROL::Objective< Real >::value(), ROL::AlgorithmState< Real >::value, ROL::BundleStep< Real >::valueNew_, ROL::BundleStep< Real >::verbosity_, ROL::BundleStep< Real >::y_, ROL::Vector< Real >::zero(), and zero.

◆ update()

template<class Real >
void ROL::BundleStep< 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::BundleStep< Real >::printHeader ( void ) const
inlinevirtual

Print iterate header.

Reimplemented from ROL::Step< Real >.

Definition at line 425 of file ROL_BundleStep.hpp.

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

◆ printName()

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

Print step name.

Reimplemented from ROL::Step< Real >.

Definition at line 442 of file ROL_BundleStep.hpp.

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

◆ print()

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

Member Data Documentation

◆ bundle_

template<class Real >
ROL::Ptr<Bundle<Real> > ROL::BundleStep< Real >::bundle_
private

◆ lineSearch_

template<class Real >
ROL::Ptr<LineSearch<Real> > ROL::BundleStep< Real >::lineSearch_
private

◆ QPiter_

template<class Real >
unsigned ROL::BundleStep< Real >::QPiter_
private

◆ QPmaxit_

template<class Real >
unsigned ROL::BundleStep< Real >::QPmaxit_
private

◆ QPtol_

template<class Real >
Real ROL::BundleStep< Real >::QPtol_
private

◆ step_flag_

template<class Real >
int ROL::BundleStep< Real >::step_flag_
private

◆ y_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::BundleStep< Real >::y_
private

◆ linErrNew_

template<class Real >
Real ROL::BundleStep< Real >::linErrNew_
private

◆ valueNew_

template<class Real >
Real ROL::BundleStep< Real >::valueNew_
private

◆ aggSubGradNew_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::BundleStep< Real >::aggSubGradNew_
private

◆ aggSubGradOldNorm_

template<class Real >
Real ROL::BundleStep< Real >::aggSubGradOldNorm_
private

◆ aggLinErrNew_

template<class Real >
Real ROL::BundleStep< Real >::aggLinErrNew_
private

◆ aggLinErrOld_

template<class Real >
Real ROL::BundleStep< Real >::aggLinErrOld_
private

Definition at line 92 of file ROL_BundleStep.hpp.

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

◆ aggDistMeasNew_

template<class Real >
Real ROL::BundleStep< Real >::aggDistMeasNew_
private

Definition at line 93 of file ROL_BundleStep.hpp.

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

◆ T_

template<class Real >
Real ROL::BundleStep< Real >::T_
private

◆ tol_

template<class Real >
Real ROL::BundleStep< Real >::tol_
private

◆ m1_

template<class Real >
Real ROL::BundleStep< Real >::m1_
private

◆ m2_

template<class Real >
Real ROL::BundleStep< Real >::m2_
private

◆ m3_

template<class Real >
Real ROL::BundleStep< Real >::m3_
private

◆ nu_

template<class Real >
Real ROL::BundleStep< Real >::nu_
private

◆ ls_maxit_

template<class Real >
int ROL::BundleStep< Real >::ls_maxit_
private

◆ first_print_

template<class Real >
bool ROL::BundleStep< Real >::first_print_
private

◆ isConvex_

template<class Real >
bool ROL::BundleStep< Real >::isConvex_
private

◆ ftol_

template<class Real >
Real ROL::BundleStep< Real >::ftol_
private

Definition at line 109 of file ROL_BundleStep.hpp.

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

◆ verbosity_

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

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