Provides the interface to compute optimization steps with nonlinear CG. More...

#include <ROL_NonlinearCG_U.hpp>

Inheritance diagram for ROL::NonlinearCG_U< Real >:

Public Member Functions
	NonlinearCG_U (ParameterList &parlist, const Ptr< NonlinearCG< Real > > &nlcg=nullPtr)
	Constructor.
void	compute (Vector< Real > &s, Real &snorm, Real &sdotg, int &iter, int &flag, const Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj) override
std::string	printName (void) const override
Public Member Functions inherited from ROL::DescentDirection_U< Real >
virtual	~DescentDirection_U ()
virtual void	initialize (const Vector< Real > &x, const Vector< Real > &g)
virtual void	update (const Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &gold, const Vector< Real > &gnew, const Real snorm, const int iter)

Private Attributes
Ptr< NonlinearCG< Real > >	nlcg_
	NonlinearCG object (used for quasi-Newton).
ENonlinearCG	enlcg_
std::string	ncgName_

Detailed Description

template<typename Real>
class ROL::NonlinearCG_U< Real >

Provides the interface to compute optimization steps with nonlinear CG.

Definition at line 28 of file ROL_NonlinearCG_U.hpp.

Constructor & Destructor Documentation

◆ NonlinearCG_U()

template<typename Real>

ROL::NonlinearCG_U< Real >::NonlinearCG_U	(	ParameterList &	parlist,
		const Ptr< NonlinearCG< Real > > &	nlcg = nullPtr )

inline

Constructor.

Constructor to build a NonlinearCG object with a user-defined nonlinear CG object. Algorithmic specifications are passed in through a ROL::ParameterList.

Parameters

[in]	parlist	is a parameter list containing algorithmic specifications
[in]	nlcg	is a user-defined NonlinearCG object

Definition at line 46 of file ROL_NonlinearCG_U.hpp.

References enlcg_, ncgName_, nlcg_, ROL::NONLINEARCG_USERDEFINED, and ROL::StringToENonlinearCG().

Member Function Documentation

◆ compute()

template<typename Real>

void ROL::NonlinearCG_U< Real >::compute	(	Vector< Real > &	s,
		Real &	snorm,
		Real &	sdotg,
		int &	iter,
		int &	flag,
		const Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj )