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

ROL

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

Public Member Functions
	StatusTest (const Real f0, const Real g0, const Real c1, const Real c2, const Real c3, const int max_nfval, ECurvatureConditionU econd, const Ptr< ScalarFunction< Real >> &phi)

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

Private Attributes
Ptr< ScalarFunction< Real > >	phi_

const Real	f0_

const Real	g0_

const Real	c1_

const Real	c2_

const Real	c3_

const int	max_nfval_

const ECurvatureConditionU	econd_

Detailed Description

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

Definition at line 128 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Constructor & Destructor Documentation

◆ StatusTest()

template<typename Real >

ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::StatusTest	(	const Real	f0,
		const Real	g0,
		const Real	c1,
		const Real	c2,
		const Real	c3,
		const int	max_nfval,
		ECurvatureConditionU	econd,
		const Ptr< ScalarFunction< Real >> &	phi
	)

inline

Definition at line 142 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Member Function Documentation

◆ check()

template<typename Real >

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

inline

Definition at line 149 of file ROL_ScalarMinimizationLineSearch_U.hpp.

References ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::c1_, ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::c2_, ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::c3_, ROL::CURVATURECONDITION_U_APPROXIMATEWOLFE, ROL::CURVATURECONDITION_U_GENERALIZEDWOLFE, ROL::CURVATURECONDITION_U_GOLDSTEIN, ROL::CURVATURECONDITION_U_NULL, ROL::CURVATURECONDITION_U_STRONGWOLFE, ROL::CURVATURECONDITION_U_WOLFE, ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::econd_, ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::f0_, ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::g0_, and ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::phi_.

Member Data Documentation

◆ phi_

template<typename Real >

Ptr<ScalarFunction<Real> > ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::phi_

private

Definition at line 130 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

◆ f0_

template<typename Real >

const Real ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::f0_

private

Definition at line 132 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

◆ g0_

template<typename Real >

const Real ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::g0_

private

Definition at line 133 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

◆ c1_

template<typename Real >

const Real ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::c1_

private

Definition at line 135 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

◆ c2_

template<typename Real >

const Real ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::c2_

private

Definition at line 136 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

◆ c3_

template<typename Real >

const Real ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::c3_

private

Definition at line 137 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

◆ max_nfval_

template<typename Real >

const int ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::max_nfval_

private

Definition at line 138 of file ROL_ScalarMinimizationLineSearch_U.hpp.

◆ econd_

template<typename Real >

const ECurvatureConditionU ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::econd_

private

Definition at line 139 of file ROL_ScalarMinimizationLineSearch_U.hpp.

Referenced by ROL::ScalarMinimizationLineSearch_U< Real >::StatusTest::check().

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

ROL_ScalarMinimizationLineSearch_U.hpp