ROL: ROL::PathBasedTargetLevel_U< Real > Class Template Reference

ROL

Provides an implementation of path-based target leve line search. More...

#include <ROL_PathBasedTargetLevel_U.hpp>

Inheritance diagram for ROL::PathBasedTargetLevel_U< Real >:

Public Member Functions
	PathBasedTargetLevel_U (ParameterList &parlist)
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_
Real	min_value_
Real	rec_value_
Real	target_
Real	delta_
Real	sigma_
Real	bound_

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::PathBasedTargetLevel_U< Real >

Provides an implementation of path-based target leve line search.

Definition at line 22 of file ROL_PathBasedTargetLevel_U.hpp.

Constructor & Destructor Documentation

◆ PathBasedTargetLevel_U()

template<typename Real>

ROL::PathBasedTargetLevel_U< Real >::PathBasedTargetLevel_U ( ParameterList & parlist )

inline

Definition at line 35 of file ROL_PathBasedTargetLevel_U.hpp.

References bound_, delta_, ROL::LineSearch_U< Real >::LineSearch_U(), min_value_, rec_value_, ROL::ROL_OVERFLOW(), sigma_, and target_.

Member Function Documentation

◆ initialize()

template<typename Real>

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

inlineoverridevirtual

Reimplemented from ROL::LineSearch_U< Real >.

Definition at line 44 of file ROL_PathBasedTargetLevel_U.hpp.

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

◆ run()

template<typename Real>

void ROL::PathBasedTargetLevel_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 50 of file ROL_PathBasedTargetLevel_U.hpp.

References bound_, delta_, min_value_, rec_value_, ROL::ROL_EPSILON(), sigma_, target_, ROL::Trial, ROL::Objective< Real >::update(), ROL::Objective< Real >::value(), xnew_, and zero.

Member Data Documentation

◆ xnew_

template<typename Real>

Ptr<Vector<Real> > ROL::PathBasedTargetLevel_U< Real >::xnew_

private

Definition at line 24 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by initialize(), and run().

◆ min_value_

template<typename Real>

Real ROL::PathBasedTargetLevel_U< Real >::min_value_

private

Definition at line 26 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by PathBasedTargetLevel_U(), and run().

◆ rec_value_

template<typename Real>

Real ROL::PathBasedTargetLevel_U< Real >::rec_value_

private

Definition at line 27 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by PathBasedTargetLevel_U(), and run().

◆ target_

template<typename Real>

Real ROL::PathBasedTargetLevel_U< Real >::target_

private

Definition at line 28 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by PathBasedTargetLevel_U(), and run().

◆ delta_

template<typename Real>

Real ROL::PathBasedTargetLevel_U< Real >::delta_

private

Definition at line 29 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by PathBasedTargetLevel_U(), and run().

◆ sigma_

template<typename Real>

Real ROL::PathBasedTargetLevel_U< Real >::sigma_

private

Definition at line 30 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by PathBasedTargetLevel_U(), and run().

◆ bound_

template<typename Real>

Real ROL::PathBasedTargetLevel_U< Real >::bound_

private

Definition at line 31 of file ROL_PathBasedTargetLevel_U.hpp.

Referenced by PathBasedTargetLevel_U(), and run().

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

ROL_PathBasedTargetLevel_U.hpp