Provides the interface to compute optimization steps with a secant method. More...

#include <ROL_SecantStep.hpp>

Inheritance diagram for ROL::SecantStep< Real >:

Public Member Functions
	SecantStep (ROL::ParameterList &parlist, const ROL::Ptr< Secant< Real > > &secant=ROL::nullPtr, const bool computeObj=true)
	Constructor. More...

void	initialize (Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Initialize step with bound constraint. More...

void	compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Compute step. More...

void	update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Update step, if successful. More...

std::string	printHeader (void) const
	Print iterate header. More...

std::string	printName (void) const
	Print step name. More...

std::string	print (AlgorithmState< Real > &algo_state, bool print_header=false) const
	Print iterate status. More...

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. More...

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. More...

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. More...

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). More...

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). More...

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). More...

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). More...

const ROL::Ptr< const StepState< Real > >	getStepState (void) const
	Get state for step object. More...

void	reset (const Real searchSize=1.0)
	Get state for step object. More...

Private Attributes
ROL::Ptr< Secant< Real > >	secant_
	Secant object (used for quasi-Newton) More...

ESecant	esec_

ROL::Ptr< Vector< Real > >	gp_
	Additional vector storage. More...

int	verbosity_
	Verbosity setting. More...

bool	computeObj_

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::SecantStep< Real >

Provides the interface to compute optimization steps with a secant method.

Definition at line 26 of file ROL_SecantStep.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::SecantStep< Real >::SecantStep	(	ROL::ParameterList &	parlist,
		const ROL::Ptr< Secant< Real > > &	secant = `ROL::nullPtr`,
		const bool	computeObj = `true`
	)

inline

Constructor.

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

Parameters

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

Definition at line 52 of file ROL_SecantStep.hpp.

References ROL::SecantStep< Real >::esec_, ROL::SecantStep< Real >::secant_, ROL::SecantStep< Real >::secantName_, ROL::StringToESecant(), and ROL::SecantStep< Real >::verbosity_.

Member Function Documentation

template<class Real >

void ROL::SecantStep< 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 71 of file ROL_SecantStep.hpp.

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

template<class Real >

void ROL::SecantStep< 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 78 of file ROL_SecantStep.hpp.

References ROL::Step< Real >::getState(), ROL::Vector< Real >::scale(), and ROL::SecantStep< Real >::secant_.

template<class Real >

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