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

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

Public Member Functions
	LineSearchStatusTest (const Real f0, const Real g0, const Real c1, const Real c2, const Real c3, const int max_nfval, ECurvatureCondition econd, const ROL::Ptr< ScalarFunction< Real > > &phi)
bool	check (Real &x, Real &fx, Real &gx, int &nfval, int &ngval, const bool deriv=false)

Private Attributes
ROL::Ptr< ScalarFunction< Real > >	phi_
const Real	f0_
const Real	g0_
const Real	c1_
const Real	c2_
const Real	c3_
const int	max_nfval_
const ECurvatureCondition	econd_

Detailed Description

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

Definition at line 80 of file ROL_ScalarMinimizationLineSearch.hpp.

Constructor & Destructor Documentation

LineSearchStatusTest()

template<class Real>

ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::LineSearchStatusTest ( const Real f0, const Real g0, const Real c1, const Real c2, const Real c3, const int max_nfval, ECurvatureCondition econd, const ROL::Ptr< ScalarFunction< Real > > & phi )

inline

Definition at line 95 of file ROL_ScalarMinimizationLineSearch.hpp.

References c1_, c2_, c3_, econd_, f0_, g0_, max_nfval_, and phi_.

Member Function Documentation

check()

template<class Real>

bool ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::check ( Real & x, Real & fx, Real & gx, int & nfval, int & ngval, const bool deriv = false )

inline

Definition at line 102 of file ROL_ScalarMinimizationLineSearch.hpp.

References c1_, c2_, c3_, ROL::CURVATURECONDITION_APPROXIMATEWOLFE, ROL::CURVATURECONDITION_GENERALIZEDWOLFE, ROL::CURVATURECONDITION_GOLDSTEIN, ROL::CURVATURECONDITION_NULL, ROL::CURVATURECONDITION_STRONGWOLFE, ROL::CURVATURECONDITION_WOLFE, econd_, f0_, g0_, and phi_.

Member Data Documentation

phi_

template<class Real>

ROL::Ptr<ScalarFunction<Real> > ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::phi_

private

Definition at line 82 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

f0_

template<class Real>

const Real ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::f0_

private

Definition at line 84 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

g0_

template<class Real>

const Real ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::g0_

private

Definition at line 85 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

c1_

template<class Real>

const Real ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::c1_

private

Definition at line 87 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

c2_

template<class Real>

const Real ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::c2_

private

Definition at line 88 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

c3_

template<class Real>

const Real ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::c3_

private

Definition at line 89 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

max_nfval_

template<class Real>

const int ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::max_nfval_

private

Definition at line 90 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by LineSearchStatusTest().

econd_

template<class Real>

const ECurvatureCondition ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::econd_

private

Definition at line 91 of file ROL_ScalarMinimizationLineSearch.hpp.

Referenced by check(), and LineSearchStatusTest().

---

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

• ROL_ScalarMinimizationLineSearch.hpp