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

Provides interface for and implements line searches. More...

#include <ROL_LineSearch.hpp>

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

Public Member Functions

virtual ~LineSearch ()
 
 LineSearch (ROL::ParameterList &parlist)
 
virtual void initialize (const Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con)
 
virtual void run (Real &alpha, Real &fval, int &ls_neval, int &ls_ngrad, const Real &gs, const Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con)=0
 
void setData (Real &eps, const Vector< Real > &g)
 
void setMaxitUpdate (Real &alpha, Real &fnew, const Real &fold)
 

Protected Member Functions

virtual bool status (const ELineSearch type, int &ls_neval, int &ls_ngrad, const Real alpha, const Real fold, const Real sgold, const Real fnew, const Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con)
 
virtual Real getInitialAlpha (int &ls_neval, int &ls_ngrad, const Real fval, const Real gs, const Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con)
 
void setNextInitialAlpha (Real alpha)
 
void updateIterate (Vector< Real > &xnew, const Vector< Real > &x, const Vector< Real > &s, Real alpha, BoundConstraint< Real > &con)
 
bool useLocalMinimizer ()
 
bool takeNoStep ()
 

Private Attributes

ECurvatureCondition econd_
 
EDescent edesc_
 
bool useralpha_
 
bool usePrevAlpha_
 
Real alpha0_
 
Real alpha0bnd_
 
int maxit_
 
Real c1_
 
Real c2_
 
Real c3_
 
Real eps_
 
Real fmin_
 
Real alphaMin_
 
bool acceptMin_
 
bool itcond_
 
ROL::Ptr< Vector< Real > > xtst_
 
ROL::Ptr< Vector< Real > > d_
 
ROL::Ptr< Vector< Real > > g_
 
ROL::Ptr< Vector< Real > > grad_
 

Detailed Description

template<class Real>
class ROL::LineSearch< Real >

Provides interface for and implements line searches.

Definition at line 62 of file ROL_LineSearch.hpp.

Constructor & Destructor Documentation

◆ ~LineSearch()

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

Definition at line 91 of file ROL_LineSearch.hpp.

◆ LineSearch()

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

Member Function Documentation

◆ initialize()

template<class Real >
virtual void ROL::LineSearch< Real >::initialize ( const Vector< Real > & x,
const Vector< Real > & s,
const Vector< Real > & g,
Objective< Real > & obj,
BoundConstraint< Real > & con )
inlinevirtual

◆ run()

template<class Real >
virtual void ROL::LineSearch< Real >::run ( Real & alpha,
Real & fval,
int & ls_neval,
int & ls_ngrad,
const Real & gs,
const Vector< Real > & s,
const Vector< Real > & x,
Objective< Real > & obj,
BoundConstraint< Real > & con )
pure virtual

◆ setData()

template<class Real >
void ROL::LineSearch< Real >::setData ( Real & eps,
const Vector< Real > & g )
inline

◆ setMaxitUpdate()

template<class Real >
void ROL::LineSearch< Real >::setMaxitUpdate ( Real & alpha,
Real & fnew,
const Real & fold )
inline

◆ status()

template<class Real >
virtual bool ROL::LineSearch< Real >::status ( const ELineSearch< Real > type,
int & ls_neval,
int & ls_ngrad,
const Real alpha,
const Real fold,
const Real sgold,
const Real fnew,
const Vector< Real > & x,
const Vector< Real > & s,
Objective< Real > & obj,
BoundConstraint< Real > & con )
inlineprotectedvirtual

◆ getInitialAlpha()

template<class Real >
virtual Real ROL::LineSearch< Real >::getInitialAlpha ( int & ls_neval,
int & ls_ngrad,
const Real fval,
const Real gs,
const Vector< Real > & x,
const Vector< Real > & s,
Objective< Real > & obj,
BoundConstraint< Real > & con )
inlineprotectedvirtual

◆ setNextInitialAlpha()

template<class Real >
void ROL::LineSearch< Real >::setNextInitialAlpha ( Real alpha)
inlineprotected

◆ updateIterate()

template<class Real >
void ROL::LineSearch< Real >::updateIterate ( Vector< Real > & xnew,
const Vector< Real > & x,
const Vector< Real > & s,
Real alpha,
BoundConstraint< Real > & con )
inlineprotected

◆ useLocalMinimizer()

template<class Real >
bool ROL::LineSearch< Real >::useLocalMinimizer ( )
inlineprotected

◆ takeNoStep()

template<class Real >
bool ROL::LineSearch< Real >::takeNoStep ( )
inlineprotected

Member Data Documentation

◆ econd_

template<class Real >
ECurvatureCondition ROL::LineSearch< Real >::econd_
private

◆ edesc_

template<class Real >
EDescent ROL::LineSearch< Real >::edesc_
private

◆ useralpha_

template<class Real >
bool ROL::LineSearch< Real >::useralpha_
private

◆ usePrevAlpha_

template<class Real >
bool ROL::LineSearch< Real >::usePrevAlpha_
private

◆ alpha0_

template<class Real >
Real ROL::LineSearch< Real >::alpha0_
private

◆ alpha0bnd_

template<class Real >
Real ROL::LineSearch< Real >::alpha0bnd_
private

◆ maxit_

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

◆ c1_

template<class Real >
Real ROL::LineSearch< Real >::c1_
private

◆ c2_

template<class Real >
Real ROL::LineSearch< Real >::c2_
private

◆ c3_

template<class Real >
Real ROL::LineSearch< Real >::c3_
private

◆ eps_

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

◆ fmin_

template<class Real >
Real ROL::LineSearch< Real >::fmin_
private

◆ alphaMin_

template<class Real >
Real ROL::LineSearch< Real >::alphaMin_
private

◆ acceptMin_

template<class Real >
bool ROL::LineSearch< Real >::acceptMin_
private

◆ itcond_

template<class Real >
bool ROL::LineSearch< Real >::itcond_
private

◆ xtst_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::LineSearch< Real >::xtst_
private

◆ d_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::LineSearch< Real >::d_
private

◆ g_

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

◆ grad_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::LineSearch< Real >::grad_
private

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