ScalarMinimizationLineSearch_U Class 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 ScalarMinimizationLineSearch_U:

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 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 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

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

Constructor & Destructor Documentation

ScalarMinimizationLineSearch_U()

ScalarMinimizationLineSearch_U::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 191 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References ROL::DESCENT_U_NONLINEARCG, ROL::StringToECurvatureConditionU(), ROL::StringToEDescentU(), and zero.

Member Function Documentation

initialize()

void ScalarMinimizationLineSearch_U::initialize ( const Vector< Real > & x, const Vector< Real > & g )

inlineoverridevirtual

Reimplemented from LineSearch_U< Real >.

Definition at line 257 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References LineSearch_U::initialize().

run()

void ScalarMinimizationLineSearch_U::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 LineSearch_U< Real >.

Definition at line 264 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References LineSearch_U< Real >::getInitialAlpha(), nfval, ngrad, and LineSearch_U< Real >::setNextInitialAlpha().

Member Data Documentation

xnew_

Ptr<Vector<Real> > ScalarMinimizationLineSearch_U::xnew_

private

Definition at line 64 of file ROL_ScalarMinimizationLineSearch_U.hpp.

g_

Ptr<Vector<Real> > ScalarMinimizationLineSearch_U::g_

private

Definition at line 65 of file ROL_ScalarMinimizationLineSearch_U.hpp.

sm_

Ptr<ScalarMinimization<Real> > ScalarMinimizationLineSearch_U::sm_

private

Definition at line 66 of file ROL_ScalarMinimizationLineSearch_U.hpp.

br_

Ptr<Bracketing<Real> > ScalarMinimizationLineSearch_U::br_

private

Definition at line 67 of file ROL_ScalarMinimizationLineSearch_U.hpp.

sf_

Ptr<ScalarFunction<Real> > ScalarMinimizationLineSearch_U::sf_

private

Definition at line 68 of file ROL_ScalarMinimizationLineSearch_U.hpp.

econd_

ECurvatureConditionU ScalarMinimizationLineSearch_U::econd_

private

Definition at line 70 of file ROL_ScalarMinimizationLineSearch_U.hpp.

c1_

Real ScalarMinimizationLineSearch_U::c1_

private

Definition at line 71 of file ROL_ScalarMinimizationLineSearch_U.hpp.

c2_

Real ScalarMinimizationLineSearch_U::c2_

private

Definition at line 72 of file ROL_ScalarMinimizationLineSearch_U.hpp.

c3_

Real ScalarMinimizationLineSearch_U::c3_

private

Definition at line 73 of file ROL_ScalarMinimizationLineSearch_U.hpp.

max_nfval_

int ScalarMinimizationLineSearch_U::max_nfval_

private

Definition at line 74 of file ROL_ScalarMinimizationLineSearch_U.hpp.

FDdirDeriv_

bool ScalarMinimizationLineSearch_U::FDdirDeriv_

private

Definition at line 76 of file ROL_ScalarMinimizationLineSearch_U.hpp.

---

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

• ROL_ScalarMinimizationLineSearch_U.hpp