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

Implements line search methods that attempt to minimize the scalar function \(\phi(t) := f(x+ts)\). More...

#include <ROL_ScalarMinimizationLineSearch_U.hpp>

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

Classes

class  Phi
 
class  StatusTest
 

Public Member Functions

 ScalarMinimizationLineSearch_U (ParameterList &parlist, const Ptr< ScalarMinimization< Real >> &sm=nullPtr, const Ptr< Bracketing< Real >> &br=nullPtr, const Ptr< ScalarFunction< Real >> &sf=nullPtr)
 
void initialize (const Vector< Real > &x, const Vector< Real > &g) override
 
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) override
 
- Public Member Functions inherited from ROL::LineSearch_U< Real >
virtual ~LineSearch_U ()
 
 LineSearch_U (ParameterList &parlist)
 
void setMaxitUpdate (Real &alpha, Real &fnew, const Real &fold)
 

Private Attributes

Ptr< Vector< Real > > xnew_
 
Ptr< Vector< Real > > g_
 
Ptr< ScalarMinimization< Real > > sm_
 
Ptr< Bracketing< Real > > br_
 
Ptr< ScalarFunction< Real > > sf_
 
ECurvatureConditionU econd_
 
Real c1_
 
Real c2_
 
Real c3_
 
int max_nfval_
 
bool FDdirDeriv_
 

Additional Inherited Members

- Protected Member Functions inherited from ROL::LineSearch_U< Real >
virtual bool status (const ELineSearchU 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)
 
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)
 
void setNextInitialAlpha (Real alpha)
 
bool useLocalMinimizer ()
 
bool takeNoStep ()
 

Detailed Description

template<typename Real>
class ROL::ScalarMinimizationLineSearch_U< Real >

Implements line search methods that attempt to minimize the scalar function \(\phi(t) := f(x+ts)\).

Definition at line 28 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Constructor & Destructor Documentation

template<typename Real >
ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U ( ParameterList &  parlist,
const Ptr< ScalarMinimization< Real >> &  sm = nullPtr,
const Ptr< Bracketing< Real >> &  br = nullPtr,
const Ptr< ScalarFunction< Real >> &  sf = nullPtr 
)
inline

Definition at line 157 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References ROL::ScalarMinimizationLineSearch_U< Real >::br_, ROL::ScalarMinimizationLineSearch_U< Real >::c1_, ROL::ScalarMinimizationLineSearch_U< Real >::c2_, ROL::ScalarMinimizationLineSearch_U< Real >::c3_, ROL::DESCENT_U_NONLINEARCG, ROL::ScalarMinimizationLineSearch_U< Real >::econd_, ROL::ScalarMinimizationLineSearch_U< Real >::FDdirDeriv_, ROL::ScalarMinimizationLineSearch_U< Real >::max_nfval_, ROL::ScalarMinimizationLineSearch_U< Real >::sf_, ROL::ScalarMinimizationLineSearch_U< Real >::sm_, ROL::StringToECurvatureConditionU(), ROL::StringToEDescentU(), and zero.

Member Function Documentation

template<typename Real >
void ROL::ScalarMinimizationLineSearch_U< Real >::initialize ( const Vector< Real > &  x,
const Vector< Real > &  g 
)
inlineoverridevirtual

Reimplemented from ROL::LineSearch_U< Real >.

Definition at line 225 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References ROL::Vector< Real >::clone(), ROL::ScalarMinimizationLineSearch_U< Real >::g_, ROL::LineSearch_U< Real >::initialize(), and ROL::ScalarMinimizationLineSearch_U< Real >::xnew_.

template<typename Real >
void ROL::ScalarMinimizationLineSearch_U< 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 
)
inlineoverridevirtual

Implements ROL::LineSearch_U< Real >.

Definition at line 232 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References ROL::ScalarMinimizationLineSearch_U< Real >::br_, ROL::ScalarMinimizationLineSearch_U< Real >::c1_, ROL::ScalarMinimizationLineSearch_U< Real >::c2_, ROL::ScalarMinimizationLineSearch_U< Real >::c3_, ROL::ScalarMinimizationLineSearch_U< Real >::econd_, ROL::ScalarMinimizationLineSearch_U< Real >::FDdirDeriv_, ROL::LineSearch_U< Real >::getInitialAlpha(), ROL::ScalarMinimizationLineSearch_U< Real >::max_nfval_, ROL::LineSearch_U< Real >::setNextInitialAlpha(), ROL::ScalarMinimizationLineSearch_U< Real >::sf_, ROL::ScalarMinimizationLineSearch_U< Real >::sm_, and ROL::ScalarMinimizationLineSearch_U< Real >::xnew_.

Member Data Documentation

template<typename Real >
Ptr<Vector<Real> > ROL::ScalarMinimizationLineSearch_U< Real >::xnew_
private

Definition at line 30 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::initialize(), and ROL::ScalarMinimizationLineSearch_U< Real >::run().

template<typename Real >
Ptr<Vector<Real> > ROL::ScalarMinimizationLineSearch_U< Real >::g_
private

Definition at line 31 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::initialize().

template<typename Real >
Ptr<ScalarMinimization<Real> > ROL::ScalarMinimizationLineSearch_U< Real >::sm_
private

Definition at line 32 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
Ptr<Bracketing<Real> > ROL::ScalarMinimizationLineSearch_U< Real >::br_
private

Definition at line 33 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
Ptr<ScalarFunction<Real> > ROL::ScalarMinimizationLineSearch_U< Real >::sf_
private

Definition at line 34 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
ECurvatureConditionU ROL::ScalarMinimizationLineSearch_U< Real >::econd_
private

Definition at line 36 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
Real ROL::ScalarMinimizationLineSearch_U< Real >::c1_
private

Definition at line 37 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
Real ROL::ScalarMinimizationLineSearch_U< Real >::c2_
private

Definition at line 38 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
Real ROL::ScalarMinimizationLineSearch_U< Real >::c3_
private

Definition at line 39 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
int ROL::ScalarMinimizationLineSearch_U< Real >::max_nfval_
private

Definition at line 40 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

template<typename Real >
bool ROL::ScalarMinimizationLineSearch_U< Real >::FDdirDeriv_
private

Definition at line 42 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::run(), and ROL::ScalarMinimizationLineSearch_U< Real >::ScalarMinimizationLineSearch_U().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5