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

Provides an interface to run the inexact proximal Newton algorithm. More...

#include <ROL_TypeP_InexactNewtonAlgorithm.hpp>

+ Inheritance diagram for ROL::TypeP::InexactNewtonAlgorithm< Real >:

Classes

class  NewtonObj
 

Public Member Functions

 InexactNewtonAlgorithm (ParameterList &list)
 
void run (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &sobj, Objective< Real > &nobj, std::ostream &outStream=std::cout) override
 Run algorithm on unconstrained problems (Type-U). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method. More...
 
void writeHeader (std::ostream &os) const override
 Print iterate header. More...
 
void writeName (std::ostream &os) const override
 Print step name. More...
 
void writeOutput (std::ostream &os, bool write_header=false) const override
 Print iterate status. More...
 
- Public Member Functions inherited from ROL::TypeP::Algorithm< Real >
virtual ~Algorithm ()
 
 Algorithm ()
 Constructor, given a step and a status test. More...
 
void setStatusTest (const Ptr< StatusTest< Real >> &status, bool combineStatus=false)
 
virtual void run (Problem< Real > &problem, std::ostream &outStream=std::cout)
 Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface. More...
 
virtual void run (Vector< Real > &x, Objective< Real > &sobj, Objective< Real > &nobj, std::ostream &outStream=std::cout)
 Run algorithm on unconstrained problems (Type-U). This is the primary Type-U interface. More...
 
virtual void writeExitStatus (std::ostream &os) const
 
Ptr< const AlgorithmState< Real > > getState () const
 
void reset ()
 

Private Member Functions

void initialize (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &sobj, Objective< Real > &nobj, Vector< Real > &dg, Vector< Real > &px, std::ostream &outStream=std::cout)
 

Private Attributes

int t0_
 
bool initProx_
 
int maxit_
 Maximum number of line search steps (default: 20) More...
 
Real rhodec_
 Backtracking rate (default: 0.5) More...
 
Real c1_
 Sufficient Decrease Parameter (default: 1e-4) More...
 
Real sigma1_
 Lower safeguard for quadratic line search (default: 0.1) More...
 
Real sigma2_
 Upper safeguard for quadratic line search (default: 0.9) More...
 
Real sp_tol1_
 
Real sp_tol2_
 
Real sp_exp_
 
Real sp_tol_min_
 
std::string algoName_
 
ParameterList list_
 
int ls_nfval_
 
int spgIter_
 
int nhess_
 
int verbosity_
 
bool writeHeader_
 

Additional Inherited Members

- Protected Member Functions inherited from ROL::TypeP::Algorithm< Real >
void initialize (const Vector< Real > &x, const Vector< Real > &g)
 
void pgstep (Vector< Real > &pgiter, Vector< Real > &pgstep, Objective< Real > &nobj, const Vector< Real > &x, const Vector< Real > &dg, Real t, Real &tol) const
 
- Protected Attributes inherited from ROL::TypeP::Algorithm< Real >
const Ptr< CombinedStatusTest
< Real > > 
status_
 
const Ptr< AlgorithmState< Real > > state_
 

Detailed Description

template<typename Real>
class ROL::TypeP::InexactNewtonAlgorithm< Real >

Provides an interface to run the inexact proximal Newton algorithm.

Definition at line 57 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

Constructor & Destructor Documentation

template<typename Real >
ROL::TypeP::InexactNewtonAlgorithm< Real >::InexactNewtonAlgorithm ( ParameterList &  list)

Member Function Documentation

template<typename Real >
void ROL::TypeP::InexactNewtonAlgorithm< Real >::initialize ( Vector< Real > &  x,
const Vector< Real > &  g,
Objective< Real > &  sobj,
Objective< Real > &  nobj,
Vector< Real > &  dg,
Vector< Real > &  px,
std::ostream &  outStream = std::cout 
)
private
template<typename Real >
void ROL::TypeP::InexactNewtonAlgorithm< Real >::run ( Vector< Real > &  x,
const Vector< Real > &  g,
Objective< Real > &  sobj,
Objective< Real > &  nobj,
std::ostream &  outStream = std::cout 
)
overridevirtual

Run algorithm on unconstrained problems (Type-U). This general interface supports the use of dual optimization vector spaces, where the user does not define the dual() method.

Implements ROL::TypeP::Algorithm< Real >.

Definition at line 118 of file ROL_TypeP_InexactNewtonAlgorithm_Def.hpp.

References ROL::Accept, ROL::Vector< Real >::clone(), ROL::Objective< Real >::gradient(), ROL::Trial, ROL::Objective< Real >::update(), ROL::Objective< Real >::value(), and ROL::TypeP::Algorithm< Real >::writeExitStatus().

template<typename Real >
void ROL::TypeP::InexactNewtonAlgorithm< Real >::writeHeader ( std::ostream &  os) const
overridevirtual

Print iterate header.

Reimplemented from ROL::TypeP::Algorithm< Real >.

Definition at line 242 of file ROL_TypeP_InexactNewtonAlgorithm_Def.hpp.

template<typename Real >
void ROL::TypeP::InexactNewtonAlgorithm< Real >::writeName ( std::ostream &  os) const
overridevirtual

Print step name.

Reimplemented from ROL::TypeP::Algorithm< Real >.

Definition at line 281 of file ROL_TypeP_InexactNewtonAlgorithm_Def.hpp.

template<typename Real >
void ROL::TypeP::InexactNewtonAlgorithm< Real >::writeOutput ( std::ostream &  os,
bool  write_header = false 
) const
overridevirtual

Print iterate status.

Reimplemented from ROL::TypeP::Algorithm< Real >.

Definition at line 288 of file ROL_TypeP_InexactNewtonAlgorithm_Def.hpp.

Member Data Documentation

template<typename Real >
int ROL::TypeP::InexactNewtonAlgorithm< Real >::t0_
private
template<typename Real >
bool ROL::TypeP::InexactNewtonAlgorithm< Real >::initProx_
private
template<typename Real >
int ROL::TypeP::InexactNewtonAlgorithm< Real >::maxit_
private

Maximum number of line search steps (default: 20)

Definition at line 62 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

Referenced by ROL::TypeP::InexactNewtonAlgorithm< Real >::InexactNewtonAlgorithm().

template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::rhodec_
private

Backtracking rate (default: 0.5)

Definition at line 63 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

Referenced by ROL::TypeP::InexactNewtonAlgorithm< Real >::InexactNewtonAlgorithm().

template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::c1_
private

Sufficient Decrease Parameter (default: 1e-4)

Definition at line 64 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

Referenced by ROL::TypeP::InexactNewtonAlgorithm< Real >::InexactNewtonAlgorithm().

template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::sigma1_
private

Lower safeguard for quadratic line search (default: 0.1)

Definition at line 65 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

Referenced by ROL::TypeP::InexactNewtonAlgorithm< Real >::InexactNewtonAlgorithm().

template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::sigma2_
private

Upper safeguard for quadratic line search (default: 0.9)

Definition at line 66 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

Referenced by ROL::TypeP::InexactNewtonAlgorithm< Real >::InexactNewtonAlgorithm().

template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::sp_tol1_
private
template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::sp_tol2_
private
template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::sp_exp_
private
template<typename Real >
Real ROL::TypeP::InexactNewtonAlgorithm< Real >::sp_tol_min_
private
template<typename Real >
std::string ROL::TypeP::InexactNewtonAlgorithm< Real >::algoName_
private
template<typename Real >
ParameterList ROL::TypeP::InexactNewtonAlgorithm< Real >::list_
private
template<typename Real >
int ROL::TypeP::InexactNewtonAlgorithm< Real >::ls_nfval_
private

Definition at line 75 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

template<typename Real >
int ROL::TypeP::InexactNewtonAlgorithm< Real >::spgIter_
private

Definition at line 75 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

template<typename Real >
int ROL::TypeP::InexactNewtonAlgorithm< Real >::nhess_
private

Definition at line 75 of file ROL_TypeP_InexactNewtonAlgorithm.hpp.

template<typename Real >
int ROL::TypeP::InexactNewtonAlgorithm< Real >::verbosity_
private
template<typename Real >
bool ROL::TypeP::InexactNewtonAlgorithm< Real >::writeHeader_
private

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