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

ROL

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

◆ Phi()

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.

References con_, ftol_, g_, obj_, ROL::ROL_EPSILON(), s_, x_, and xnew_.

Member Function Documentation

◆ updateIterate()

template<class Real>

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

inlineprivate

Definition at line 51 of file ROL_ScalarMinimizationLineSearch.hpp.

References con_, s_, x_, and xnew_.

Referenced by deriv(), and value().

◆ value()

template<class Real>

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

inline

Definition at line 67 of file ROL_ScalarMinimizationLineSearch.hpp.

References ftol_, obj_, updateIterate(), and xnew_.

◆ deriv()

template<class Real>

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

inline

Definition at line 72 of file ROL_ScalarMinimizationLineSearch.hpp.

References ftol_, g_, obj_, s_, updateIterate(), and xnew_.

Member Data Documentation

◆ xnew_

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 deriv(), Phi(), updateIterate(), and value().

◆ g_

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 deriv(), and Phi().

◆ x_

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 Phi(), and updateIterate().

◆ s_

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 deriv(), Phi(), and updateIterate().

◆ obj_

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 deriv(), Phi(), and value().

◆ con_

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 Phi(), and updateIterate().

◆ ftol_

template<class Real>

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

private

Definition at line 50 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by deriv(), Phi(), and value().

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

ROL_ScalarMinimizationLineSearch.hpp