ROL::ScalarMinimizationLineSearch< Real > Class Template Reference

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

#include <ROL_ScalarMinimizationLineSearch.hpp>

Inheritance diagram for ROL::ScalarMinimizationLineSearch< Real >:

Classes
class	LineSearchStatusTest
class	Phi

Public Member Functions
	ScalarMinimizationLineSearch (Teuchos::ParameterList &parlist, const Teuchos::RCP< ScalarMinimization< Real > > &sm=Teuchos::null, const Teuchos::RCP< Bracketing< Real > > &br=Teuchos::null, const Teuchos::RCP< ScalarFunction< Real > > &sf=Teuchos::null)
void	initialize (const Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con)
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)
Public Member Functions inherited from ROL::LineSearch< Real >
virtual	~LineSearch ()
	LineSearch (Teuchos::ParameterList &parlist)
void	setData (Real &eps, const Vector< Real > &g)
void	setMaxitUpdate (Real &alpha, Real &fnew, const Real &fold)

Private Attributes
Teuchos::RCP< Vector< Real > >	xnew_
Teuchos::RCP< Vector< Real > >	g_
Teuchos::RCP< ScalarMinimization< Real > >	sm_
Teuchos::RCP< Bracketing< Real > >	br_
Teuchos::RCP< ScalarFunction< Real > >	sf_
ECurvatureCondition	econd_
Real	c1_
Real	c2_
Real	c3_
int	max_nfval_

Additional Inherited Members
Protected Member Functions inherited from ROL::LineSearch< Real >
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 ()

Detailed Description

template<class Real>
class ROL::ScalarMinimizationLineSearch< Real >

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

Definition at line 62 of file ROL_ScalarMinimizationLineSearch.hpp.

Constructor & Destructor Documentation

ScalarMinimizationLineSearch()

template<class Real >

ROL::ScalarMinimizationLineSearch< Real >::ScalarMinimizationLineSearch ( Teuchos::ParameterList &  parlist, const Teuchos::RCP< ScalarMinimization< Real > > &  sm = Teuchos::null, const Teuchos::RCP< Bracketing< Real > > &  br = Teuchos::null, const Teuchos::RCP< ScalarFunction< Real > > &  sf = Teuchos::null  )

inline

Definition at line 175 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::DESCENT_NONLINEARCG, ROL::StringToECurvatureCondition(), and ROL::StringToEDescent().

Member Function Documentation

initialize()

template<class Real >

void ROL::ScalarMinimizationLineSearch< Real >::initialize ( const Vector< Real > &  x, const Vector< Real > &  s, const Vector< Real > &  g, Objective< Real > &  obj, BoundConstraint< Real > &  con  )

inlinevirtual

Reimplemented from ROL::LineSearch< Real >.

Definition at line 243 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::Vector< Real >::clone(), and ROL::LineSearch< Real >::initialize().

run()

template<class Real >

void ROL::ScalarMinimizationLineSearch< 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  )

inlinevirtual

Implements ROL::LineSearch< Real >.

Definition at line 251 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::LineSearch< Real >::getInitialAlpha(), ROL::ScalarMinimizationLineSearch< Real >::Phi::Phi(), ROL::LineSearch< Real >::setNextInitialAlpha(), and ROL::ScalarMinimizationLineSearch< Real >::sf_.

Member Data Documentation

xnew_

template<class Real >

Teuchos::RCP<Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::xnew_

private

Definition at line 64 of file ROL_ScalarMinimizationLineSearch.hpp.

g_

template<class Real >

Teuchos::RCP<Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::g_

private

Definition at line 65 of file ROL_ScalarMinimizationLineSearch.hpp.

sm_

template<class Real >

Teuchos::RCP<ScalarMinimization<Real> > ROL::ScalarMinimizationLineSearch< Real >::sm_

private

Definition at line 66 of file ROL_ScalarMinimizationLineSearch.hpp.

br_

template<class Real >

Teuchos::RCP<Bracketing<Real> > ROL::ScalarMinimizationLineSearch< Real >::br_

private

Definition at line 67 of file ROL_ScalarMinimizationLineSearch.hpp.

sf_

template<class Real >

Teuchos::RCP<ScalarFunction<Real> > ROL::ScalarMinimizationLineSearch< Real >::sf_

private

Definition at line 68 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::run().

econd_

template<class Real >

ECurvatureCondition ROL::ScalarMinimizationLineSearch< Real >::econd_

private

Definition at line 70 of file ROL_ScalarMinimizationLineSearch.hpp.

c1_

template<class Real >

Real ROL::ScalarMinimizationLineSearch< Real >::c1_

private

Definition at line 71 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::check().

c2_

template<class Real >

Real ROL::ScalarMinimizationLineSearch< Real >::c2_

private

Definition at line 72 of file ROL_ScalarMinimizationLineSearch.hpp.

c3_

template<class Real >

Real ROL::ScalarMinimizationLineSearch< Real >::c3_

private

Definition at line 73 of file ROL_ScalarMinimizationLineSearch.hpp.

max_nfval_

template<class Real >

int ROL::ScalarMinimizationLineSearch< Real >::max_nfval_

private

Definition at line 74 of file ROL_ScalarMinimizationLineSearch.hpp.

---

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

• ROL_ScalarMinimizationLineSearch.hpp