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

ROL

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

Public Member Functions
	Phi (const Ptr< Vector< Real > > &xnew, const Ptr< const Vector< Real > > &x, const Ptr< const Vector< Real > > &s, const Ptr< Objective< Real > > &obj, const bool FDdirDeriv=false)
Real	value (const Real alpha)
Real	deriv (const Real alpha)

Private Attributes
const Ptr< Vector< Real > >	xnew_
const Ptr< const Vector< Real > >	x_
const Ptr< const Vector< Real > >	s_
const Ptr< Objective< Real > >	obj_
Real	ftol_
Real	alpha_
Real	val_
bool	FDdirDeriv_

Detailed Description

template<typename Real>
class ROL::ScalarMinimizationLineSearch_U< Real >::Phi

Definition at line 44 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Constructor & Destructor Documentation

◆ Phi()

template<typename Real>

ROL::ScalarMinimizationLineSearch_U< Real >::Phi::Phi	(	const Ptr< Vector< Real > > &	xnew,
		const Ptr< const Vector< Real > > &	x,
		const Ptr< const Vector< Real > > &	s,
		const Ptr< Objective< Real > > &	obj,
		const bool	FDdirDeriv = false )

inline

Definition at line 52 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References alpha_, FDdirDeriv_, ftol_, obj_, ROL::ROL_EPSILON(), ROL::ROL_INF(), s_, val_, x_, and xnew_.

Member Function Documentation

◆ value()

template<typename Real>

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

inline

Definition at line 61 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References alpha_, ftol_, obj_, s_, ROL::Trial, val_, x_, and xnew_.

Referenced by deriv().

◆ deriv()

template<typename Real>

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

inline

Definition at line 70 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References FDdirDeriv_, obj_, ROL::ROL_EPSILON(), s_, ROL::Trial, value(), x_, and xnew_.

Member Data Documentation

◆ xnew_

template<typename Real>

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

private

Definition at line 46 of file ROL_ScalarMinimizationLineSearch_U.hpp.

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

◆ x_

template<typename Real>

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

private

Definition at line 47 of file ROL_ScalarMinimizationLineSearch_U.hpp.

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

◆ s_

template<typename Real>

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

private

Definition at line 47 of file ROL_ScalarMinimizationLineSearch_U.hpp.

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

◆ obj_

template<typename Real>

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

private

Definition at line 48 of file ROL_ScalarMinimizationLineSearch_U.hpp.

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

◆ ftol_

template<typename Real>

Real ROL::ScalarMinimizationLineSearch_U< Real >::Phi::ftol_

private

Definition at line 49 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by Phi(), and value().

◆ alpha_

template<typename Real>

Real ROL::ScalarMinimizationLineSearch_U< Real >::Phi::alpha_

private

Definition at line 49 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by Phi(), and value().

◆ val_

template<typename Real>

Real ROL::ScalarMinimizationLineSearch_U< Real >::Phi::val_

private

Definition at line 49 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by Phi(), and value().

◆ FDdirDeriv_

template<typename Real>

bool ROL::ScalarMinimizationLineSearch_U< Real >::Phi::FDdirDeriv_

private

Definition at line 50 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by deriv(), and Phi().

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

ROL_ScalarMinimizationLineSearch_U.hpp