Provides the interface to compute optimization steps with projected inexact ProjectedNewton's method using line search. More...

#include <ROL_ProjectedNewtonKrylovStep.hpp>

Inheritance diagram for ROL::ProjectedNewtonKrylovStep< Real >:

Classes
class	HessianPNK
class	PrecondPNK

Public Member Functions
	ProjectedNewtonKrylovStep (ROL::ParameterList &parlist, const bool computeObj=true)
	Constructor.
	ProjectedNewtonKrylovStep (ROL::ParameterList &parlist, const ROL::Ptr< Krylov< Real > > &krylov, const ROL::Ptr< Secant< Real > > &secant, const bool computeObj=true)
	Constructor.
void	initialize (Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Initialize step with bound constraint.
void	compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Compute step.
void	update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Update step, if successful.
std::string	printHeader (void) const
	Print iterate header.
std::string	printName (void) const
	Print step name.
std::string	print (AlgorithmState< Real > &algo_state, bool print_header=false) const
	Print iterate status.
Public Member Functions inherited from ROL::Step< Real >
virtual	~Step ()
	Step (void)
virtual void	initialize (Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Initialize step with bound constraint.
virtual void	initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, Constraint< Real > &con, AlgorithmState< Real > &algo_state)
	Initialize step with equality constraint.
virtual void	initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Initialize step with equality constraint.
virtual void	compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, Constraint< Real > &con, AlgorithmState< Real > &algo_state)
	Compute step (equality constraints).
virtual void	update (Vector< Real > &x, Vector< Real > &l, const Vector< Real > &s, Objective< Real > &obj, Constraint< Real > &con, AlgorithmState< Real > &algo_state)
	Update step, if successful (equality constraints).
virtual void	compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Compute step (equality constraints).
virtual void	update (Vector< Real > &x, Vector< Real > &l, const Vector< Real > &s, Objective< Real > &obj, Constraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Update step, if successful (equality constraints).
const ROL::Ptr< const StepState< Real > >	getStepState (void) const
	Get state for step object.
void	reset (const Real searchSize=1.0)
	Get state for step object.

Private Attributes
ROL::Ptr< Secant< Real > >	secant_
	Secant object (used for quasi-Newton).
ROL::Ptr< Krylov< Real > >	krylov_
	Krylov solver object (used for inexact Newton).
EKrylov	ekv_
ESecant	esec_
ROL::Ptr< Vector< Real > >	gp_
ROL::Ptr< Vector< Real > >	d_
int	iterKrylov_
	Number of Krylov iterations (used for inexact Newton).
int	flagKrylov_
	Termination flag for Krylov method (used for inexact Newton).
int	verbosity_
	Verbosity level.
const bool	computeObj_
bool	useSecantPrecond_
	Whether or not a secant approximation is used for preconditioning inexact Newton.
bool	useProjectedGrad_
	Whether or not to use to the projected gradient criticality measure.
std::string	krylovName_
std::string	secantName_

Additional Inherited Members
Protected Member Functions inherited from ROL::Step< Real >
ROL::Ptr< StepState< Real > >	getState (void)

Detailed Description

template<class Real>
class ROL::ProjectedNewtonKrylovStep< Real >

Provides the interface to compute optimization steps with projected inexact ProjectedNewton's method using line search.

Definition at line 33 of file ROL_ProjectedNewtonKrylovStep.hpp.

Constructor & Destructor Documentation

◆ ProjectedNewtonKrylovStep() [1/2]

template<class Real>

ROL::ProjectedNewtonKrylovStep< Real >::ProjectedNewtonKrylovStep	(	ROL::ParameterList &	parlist,
		const bool	computeObj = true )

inline

Constructor.

Standard constructor to build a ProjectedNewtonKrylovStep object. Algorithmic specifications are passed in through a ROL::ParameterList.

Parameters

[in] parlist is a parameter list containing algorithmic specifications

Definition at line 143 of file ROL_ProjectedNewtonKrylovStep.hpp.

References computeObj_, d_, ekv_, esec_, flagKrylov_, gp_, iterKrylov_, krylov_, ROL::KrylovFactory(), krylovName_, secant_, ROL::SecantFactory(), secantName_, ROL::Step< Real >::Step(), ROL::StringToEKrylov(), ROL::StringToESecant(), useProjectedGrad_, useSecantPrecond_, and verbosity_.

◆ ProjectedNewtonKrylovStep() [2/2]

template<class Real>

ROL::ProjectedNewtonKrylovStep< Real >::ProjectedNewtonKrylovStep	(	ROL::ParameterList &	parlist,
		const ROL::Ptr< Krylov< Real > > &	krylov,
		const ROL::Ptr< Secant< Real > > &	secant,
		const bool	computeObj = true )

inline

Constructor.

Constructor to build a ProjectedNewtonKrylovStep object with user-defined secant and Krylov objects. Algorithmic specifications are passed in through a ROL::ParameterList.

Parameters

[in]	parlist	is a parameter list containing algorithmic specifications
[in]	krylov	is a user-defined Krylov object
[in]	secant	is a user-defined secant object

Definition at line 175 of file ROL_ProjectedNewtonKrylovStep.hpp.

References computeObj_, d_, ekv_, esec_, flagKrylov_, gp_, iterKrylov_, krylov_, ROL::KRYLOV_USERDEFINED, ROL::KrylovFactory(), krylovName_, secant_, ROL::SECANT_USERDEFINED, ROL::SecantFactory(), secantName_, ROL::Step< Real >::Step(), ROL::StringToEKrylov(), ROL::StringToESecant(), useProjectedGrad_, useSecantPrecond_, and verbosity_.

Member Function Documentation

◆ initialize()

template<class Real>

void ROL::ProjectedNewtonKrylovStep< Real >::initialize	(	Vector< Real > &	x,
		const Vector< Real > &	s,
		const Vector< Real > &	g,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	con,
		AlgorithmState< Real > &	algo_state )

inlinevirtual

Initialize step with bound constraint.

Reimplemented from ROL::Step< Real >.

Definition at line 209 of file ROL_ProjectedNewtonKrylovStep.hpp.

References ROL::Vector< Real >::clone(), d_, gp_, and ROL::Step< Real >::initialize().

◆ compute()

template<class Real>

void ROL::ProjectedNewtonKrylovStep< Real >::compute	(	Vector< Real > &	s,
		const Vector< Real > &	x,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	bnd,
		AlgorithmState< Real > &	algo_state )

inlinevirtual

Compute step.

Reimplemented from ROL::Step< Real >.

Definition at line 217 of file ROL_ProjectedNewtonKrylovStep.hpp.

References flagKrylov_, ROL::Step< Real >::getState(), ROL::AlgorithmState< Real >::gnorm, ROL::AlgorithmState< Real >::iterateVec, iterKrylov_, krylov_, ROL::Vector< Real >::scale(), secant_, ROL::Vector< Real >::set(), and useSecantPrecond_.

◆ update()

template<class Real>

void ROL::ProjectedNewtonKrylovStep< Real >::update	(	Vector< Real > &	x,
		const Vector< Real > &	s,
		Objective< Real > &	obj,
		BoundConstraint< Real > &	bnd,
		AlgorithmState< Real > &	algo_state )