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

ROL

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

Public Member Functions
	Phi (const Teuchos::RCP< Vector< Real > > &xnew, const Teuchos::RCP< Vector< Real > > &g, const Teuchos::RCP< const Vector< Real > > &x, const Teuchos::RCP< const Vector< Real > > &s, const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< BoundConstraint< Real > > &con)

Real	value (const Real alpha)

Real	deriv (const Real alpha)

Private Member Functions
void	updateIterate (Real alpha)

Private Attributes
const Teuchos::RCP< Vector< Real > >	xnew_

const Teuchos::RCP< Vector< Real > >	g_

const Teuchos::RCP< const Vector< Real > >	x_

const Teuchos::RCP< const Vector< Real > >	s_

const Teuchos::RCP< Objective< Real > >	obj_

const Teuchos::RCP< BoundConstraint< Real > >	con_

Real	ftol_

Detailed Description

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

Definition at line 76 of file ROL_ScalarMinimizationLineSearch.hpp.

Constructor & Destructor Documentation

◆ Phi()

template<class Real >

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

inline

Definition at line 93 of file ROL_ScalarMinimizationLineSearch.hpp.

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

Member Function Documentation

◆ updateIterate()

template<class Real >

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

inlineprivate

Definition at line 85 of file ROL_ScalarMinimizationLineSearch.hpp.

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

◆ value()

template<class Real >

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

inline

Definition at line 101 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate().

◆ deriv()

template<class Real >

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

inline

Definition at line 106 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::ScalarMinimizationLineSearch< Real >::Phi::updateIterate().

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

Member Data Documentation

◆ xnew_

template<class Real >

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

private

Definition at line 78 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ g_

template<class Real >

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

private

Definition at line 79 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ x_

template<class Real >

const Teuchos::RCP<const Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::x_

private

Definition at line 80 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ s_

template<class Real >

const Teuchos::RCP<const Vector<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::s_

private

Definition at line 81 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ obj_

template<class Real >

const Teuchos::RCP<Objective<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::obj_

private

Definition at line 82 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ con_

template<class Real >

const Teuchos::RCP<BoundConstraint<Real> > ROL::ScalarMinimizationLineSearch< Real >::Phi::con_

private

Definition at line 83 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ ftol_

template<class Real >

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

private

Definition at line 84 of file ROL_ScalarMinimizationLineSearch.hpp.

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

ROL_ScalarMinimizationLineSearch.hpp