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

ROL

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 Teuchos::RCP< ScalarFunction< Real > > &phi)

bool	check (Real &x, Real &fx, Real &gx, int &nfval, int &ngval, const bool deriv=false)

Private Attributes
Teuchos::RCP< 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

◆ 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 Teuchos::RCP< ScalarFunction< Real > > &	phi
	)

inline

Definition at line 129 of file ROL_ScalarMinimizationLineSearch.hpp.

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

References ROL::ScalarMinimizationLineSearch< Real >::c1_, ROL::CURVATURECONDITION_APPROXIMATEWOLFE, ROL::CURVATURECONDITION_GENERALIZEDWOLFE, ROL::CURVATURECONDITION_GOLDSTEIN, ROL::CURVATURECONDITION_NULL, ROL::CURVATURECONDITION_STRONGWOLFE, ROL::CURVATURECONDITION_WOLFE, and ROL::ScalarMinimizationLineSearch< Real >::Phi::deriv().

Member Data Documentation

◆ phi_

template<class Real >

Teuchos::RCP<ScalarFunction<Real> > ROL::ScalarMinimizationLineSearch< Real >::LineSearchStatusTest::phi_

private

Definition at line 116 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ f0_

template<class Real >

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

private

Definition at line 118 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ g0_

template<class Real >

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

private

Definition at line 119 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ c1_

template<class Real >

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

private

Definition at line 121 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ c2_

template<class Real >

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

private

Definition at line 122 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ c3_

template<class Real >

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

private

Definition at line 123 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ max_nfval_

template<class Real >

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

private

Definition at line 124 of file ROL_ScalarMinimizationLineSearch.hpp.

◆ econd_

template<class Real >

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

private

Definition at line 125 of file ROL_ScalarMinimizationLineSearch.hpp.

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

ROL_ScalarMinimizationLineSearch.hpp