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 114 of file ROL_ScalarMinimizationLineSearch.hpp.

Constructor & Destructor Documentation

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 129 of file ROL_ScalarMinimizationLineSearch.hpp.

Member Function Documentation

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 136 of file ROL_ScalarMinimizationLineSearch.hpp.

References ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::c1_, ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::c2_, ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::c3_, ROL::CURVATURECONDITION_APPROXIMATEWOLFE, ROL::CURVATURECONDITION_GENERALIZEDWOLFE, ROL::CURVATURECONDITION_GOLDSTEIN, ROL::CURVATURECONDITION_NULL, ROL::CURVATURECONDITION_STRONGWOLFE, ROL::CURVATURECONDITION_WOLFE, ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::econd_, ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::f0_, ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::g0_, and ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::phi_.

Member Data Documentation

template<class Real >

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

private

Definition at line 116 of file ROL_ScalarMinimizationLineSearch.hpp.

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

template<class Real >

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

private

Definition at line 118 of file ROL_ScalarMinimizationLineSearch.hpp.

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

template<class Real >

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

private

Definition at line 119 of file ROL_ScalarMinimizationLineSearch.hpp.

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

template<class Real >

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

private

Definition at line 121 of file ROL_ScalarMinimizationLineSearch.hpp.

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

template<class Real >

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

private

Definition at line 122 of file ROL_ScalarMinimizationLineSearch.hpp.

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

template<class Real >

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

private

Definition at line 123 of file ROL_ScalarMinimizationLineSearch.hpp.

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

template<class Real >

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

private

Definition at line 124 of file ROL_ScalarMinimizationLineSearch.hpp.

template<class Real >

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

private

Definition at line 125 of file ROL_ScalarMinimizationLineSearch.hpp.

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

---

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

• ROL_ScalarMinimizationLineSearch.hpp