ROL::ScalarMinimizationLineSearch< Real >::Phi Class Reference

Inheritance diagram for ROL::ScalarMinimizationLineSearch< Real >::Phi:

Public Member Functions
	Phi (const ROL::Ptr< Vector< Real > > &xnew, const ROL::Ptr< Vector< Real > > &g, const ROL::Ptr< const Vector< Real > > &x, const ROL::Ptr< const Vector< Real > > &s, const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< BoundConstraint< Real > > &con)
Real	value (const Real alpha)
Real	deriv (const Real alpha)

Private Member Functions
void	updateIterate (Real alpha)

Private Attributes
const ROL::Ptr< Vector< Real > >	xnew_
const ROL::Ptr< Vector< Real > >	g_
const ROL::Ptr< const Vector < Real > >	x_
const ROL::Ptr< const Vector < Real > >	s_
const ROL::Ptr< Objective< Real > >	obj_
const ROL::Ptr < BoundConstraint< Real > >	con_
Real	ftol_

Detailed Description

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

Definition at line 42 of file ROL_ScalarMinimizationLineSearch.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::ScalarMinimizationLineSearch< Real >::Phi::Phi ( const ROL::Ptr< Vector< Real > > &  xnew, const ROL::Ptr< Vector< Real > > &  g, const ROL::Ptr< const Vector< Real > > &  x, const ROL::Ptr< const Vector< Real > > &  s, const ROL::Ptr< Objective< Real > > &  obj, const ROL::Ptr< BoundConstraint< Real > > &  con  )

inline

Definition at line 59 of file ROL_ScalarMinimizationLineSearch.hpp.

Member Function Documentation

template<class Real >

void ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate ( Real  alpha )

inlineprivate

Definition at line 51 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::ScalarMinimizationLineSearch< Real >::Phi::con_, ROL::ScalarMinimizationLineSearch< Real >::Phi::s_, ROL::ScalarMinimizationLineSearch< Real >::Phi::x_, and ROL::ScalarMinimizationLineSearch< Real >::Phi::xnew_.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::value().

template<class Real >

Real ROL::ScalarMinimizationLineSearch< Real >::Phi::value ( const Real  alpha )

inline

Definition at line 67 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::ScalarMinimizationLineSearch< Real >::Phi::ftol_, ROL::ScalarMinimizationLineSearch< Real >::Phi::obj_, ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::xnew_.

template<class Real >

Real ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv ( const Real  alpha )

inline

Definition at line 72 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::ScalarMinimizationLineSearch< Real >::Phi::ftol_, ROL::ScalarMinimizationLineSearch< Real >::Phi::g_, ROL::ScalarMinimizationLineSearch< Real >::Phi::obj_, ROL::ScalarMinimizationLineSearch< Real >::Phi::s_, ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::xnew_.

Member Data Documentation

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::xnew_

private

Definition at line 44 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv(), ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::value().

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::g_

private

Definition at line 45 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv().

template<class Real >

const ROL::Ptr<const Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::x_

private

Definition at line 46 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate().

template<class Real >

const ROL::Ptr<const Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::s_

private

Definition at line 47 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate().

template<class Real >

const ROL::Ptr<Objective<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::obj_

private

Definition at line 48 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::value().

template<class Real >

const ROL::Ptr<BoundConstraint<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::con_

private

Definition at line 49 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate().

template<class Real >

Real ROL::ScalarMinimizationLineSearch< Real >::Phi::ftol_

private

Definition at line 50 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv(), and ROL::ScalarMinimizationLineSearch< Real >::Phi::value().

---

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

• ROL_ScalarMinimizationLineSearch.hpp