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

◆ ScalarMinimizationLineSearch_U()

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 br_, c1_, c2_, c3_, ROL::DESCENT_U_NONLINEARCG, econd_, FDdirDeriv_, ROL::LineSearch_U< Real >::LineSearch_U(), max_nfval_, sf_, sm_, ROL::StringToECurvatureConditionU(), ROL::StringToEDescentU(), and zero.

Member Function Documentation

◆ initialize()

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(), g_, ROL::LineSearch_U< Real >::initialize(), and xnew_.

◆ run()

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 br_, c1_, c2_, c3_, econd_, FDdirDeriv_, ROL::LineSearch_U< Real >::getInitialAlpha(), max_nfval_, ROL::LineSearch_U< Real >::setNextInitialAlpha(), sf_, sm_, and xnew_.

Member Data Documentation

◆ xnew_

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

Definition at line 30 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by initialize(), and run().

◆ g_

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

Definition at line 31 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by initialize().

◆ sm_

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

Definition at line 32 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ br_

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

Definition at line 33 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ sf_

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

Definition at line 34 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ econd_

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

Definition at line 36 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ c1_

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

Definition at line 37 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ c2_

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

Definition at line 38 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ c3_

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

Definition at line 39 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ max_nfval_

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

Definition at line 40 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

◆ FDdirDeriv_

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

Definition at line 42 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by run(), and ScalarMinimizationLineSearch_U().

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