#include <ROL_InteriorPointStep.hpp>

Inheritance diagram for ROL::InteriorPointStep< Real >:

Public Member Functions
	~InteriorPointStep ()

	InteriorPointStep (Teuchos::ParameterList &parlist)

void	initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, EqualityConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Initialize step with equality constraint. More...

void	initialize (Vector< Real > &x, const Vector< Real > &g, Vector< Real > &l, const Vector< Real > &c, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Initialize step with equality constraint. More...

void	compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, EqualityConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Compute step (equality constraints). More...

virtual void	compute (Vector< Real > &s, const Vector< Real > &x, const Vector< Real > &l, Objective< Real > &obj, EqualityConstraint< Real > &con, BoundConstraint< Real > &bnd, AlgorithmState< Real > &algo_state)
	Compute step (equality constraints). More...

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

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

virtual void	compute (Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Compute step for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring. More...

virtual void	update (Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Update step, for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring. 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 pHeader=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 > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con, AlgorithmState< Real > &algo_state)
	Initialize step with bound constraint. More...

void	initialize (OptimizationProblem< Real > &opt, AlgorithmState< Real > &algo_state)

void	compute (Vector< Real > &s, OptimizationProblem< Real > &opt, AlgorithmState< Real > &algo_state)

void	update (OptimizationProblem< Real > &opt, const Vector< Real > &s, AlgorithmState< Real > &algo_state)

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

Private Types
typedef InteriorPoint::PenalizedObjective< Real >	IPOBJ

typedef InteriorPoint::CompositeConstraint< Real >	IPCON

typedef PartitionedVector< Real >	PV

typedef PV::size_type	size_type

Private Attributes
Teuchos::RCP< StatusTest< Real > >	status_

Teuchos::RCP< Step< Real > >	step_

Teuchos::RCP< IPOBJ >	ipobj_

Teuchos::RCP< IPCON >	ipcon_

Teuchos::RCP< Algorithm< Real > >	algo_

Teuchos::RCP< Teuchos::ParameterList >	parlist_

Teuchos::RCP< PV >	x_

Teuchos::RCP< Vector< Real > >	g_

Teuchos::RCP< Vector< Real > >	l_

Teuchos::RCP< Vector< Real > >	c_

Real	mu_

Real	mumin_

Real	mumax_

Real	rho_

int	maxit_

Real	gtol_

Real	ctol_

Real	stol_

int	subproblemIter_

int	verbosity_

Static Private Attributes
static const size_type	OPT = 0

static const size_type	SLACK = 1

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

Detailed Description

template<class Real>
class ROL::InteriorPointStep< Real >

Definition at line 57 of file ROL_InteriorPointStep.hpp.

Member Typedef Documentation

◆ IPOBJ

template<class Real >

typedef InteriorPoint::PenalizedObjective<Real> ROL::InteriorPointStep< Real >::IPOBJ

private

Definition at line 59 of file ROL_InteriorPointStep.hpp.

◆ IPCON

template<class Real >

typedef InteriorPoint::CompositeConstraint<Real> ROL::InteriorPointStep< Real >::IPCON

private

Definition at line 60 of file ROL_InteriorPointStep.hpp.

◆ PV

template<class Real >

typedef PartitionedVector<Real> ROL::InteriorPointStep< Real >::PV

private

Definition at line 62 of file ROL_InteriorPointStep.hpp.

◆ size_type

template<class Real >

typedef PV::size_type ROL::InteriorPointStep< Real >::size_type

private

Definition at line 63 of file ROL_InteriorPointStep.hpp.

Constructor & Destructor Documentation

◆ ~InteriorPointStep()

template<class Real >

ROL::InteriorPointStep< Real >::~InteriorPointStep ( )

inline

Definition at line 103 of file ROL_InteriorPointStep.hpp.

◆ InteriorPointStep()

template<class Real >

ROL::InteriorPointStep< Real >::InteriorPointStep ( Teuchos::ParameterList & parlist )

inline

Definition at line 105 of file ROL_InteriorPointStep.hpp.

Member Function Documentation

◆ initialize() [1/2]

template<class Real >

void ROL::InteriorPointStep< Real >::initialize	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Vector< Real > &	l,
		const Vector< Real > &	c,
		Objective< Real > &	obj,
		EqualityConstraint< Real > &	con,
		AlgorithmState< Real > &	algo_state
	)

inlinevirtual

Initialize step with equality constraint.

Reimplemented from ROL::Step< Real >.

Definition at line 145 of file ROL_InteriorPointStep.hpp.

References ROL::Vector< Real >::clone(), ROL::AlgorithmState< Real >::cnorm, ROL::Step< Real >::getState(), ROL::AlgorithmState< Real >::gnorm, ROL::Objective< Real >::gradient(), ROL::AlgorithmState< Real >::iter, ROL::AlgorithmState< Real >::ncval, ROL::AlgorithmState< Real >::nfval, ROL::AlgorithmState< Real >::ngrad, ROL::Objective< Real >::update(), ROL::AlgorithmState< Real >::value, ROL::Objective< Real >::value(), and ROL::EqualityConstraint< Real >::value().

Referenced by ROL::InteriorPointStep< Real >::initialize().

◆ initialize() [2/2]

template<class Real >

void ROL::InteriorPointStep< Real >::initialize	(	Vector< Real > &	x,
		const Vector< Real > &	g,
		Vector< Real > &	l,
		const Vector< Real > &	c,
		Objective< Real > &	obj,
		EqualityConstraint< Real > &	con,
		BoundConstraint< Real > &	bnd,
		AlgorithmState< Real > &	algo_state
	)

inlinevirtual

Initialize step with equality constraint.

Reimplemented from ROL::Step< Real >.

Definition at line 191 of file ROL_InteriorPointStep.hpp.

References ROL::InteriorPointStep< Real >::initialize().

◆ compute() [1/3]

template<class Real >

void ROL::InteriorPointStep< Real >::compute	(	Vector< Real > &	s,
		const Vector< Real > &	x,
		const Vector< Real > &	l,
		Objective< Real > &	obj,
		EqualityConstraint< Real > &	con,
		AlgorithmState< Real > &	algo_state
	)

inlinevirtual

Compute step (equality constraints).

Reimplemented from ROL::Step< Real >.

Definition at line 202 of file ROL_InteriorPointStep.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::set().

Referenced by ROL::InteriorPointStep< Real >::compute().

◆ compute() [2/3]

template<class Real >

virtual void ROL::InteriorPointStep< Real >::compute	(	Vector< Real > &	s,
		const Vector< Real > &	x,
		const Vector< Real > &	l,
		Objective< Real > &	obj,
		EqualityConstraint< Real > &	con,
		BoundConstraint< Real > &	bnd,
		AlgorithmState< Real > &	algo_state
	)

inlinevirtual

Compute step (equality constraints).

Reimplemented from ROL::Step< Real >.

Definition at line 221 of file ROL_InteriorPointStep.hpp.

References ROL::InteriorPointStep< Real >::compute().

◆ update() [1/3]

template<class Real >

void ROL::InteriorPointStep< Real >::update	(	Vector< Real > &	x,
		Vector< Real > &	l,
		const Vector< Real > &	s,
		Objective< Real > &	obj,
		EqualityConstraint< Real > &	con,
		AlgorithmState< Real > &	algo_state
	)

inlinevirtual

Update step, if successful (equality constraints).

Reimplemented from ROL::Step< Real >.

Definition at line 232 of file ROL_InteriorPointStep.hpp.

References ROL::AlgorithmState< Real >::cnorm, ROL::Step< Real >::getState(), ROL::AlgorithmState< Real >::gnorm, ROL::AlgorithmState< Real >::iter, ROL::AlgorithmState< Real >::iterateVec, ROL::AlgorithmState< Real >::ncval, ROL::AlgorithmState< Real >::nfval, ROL::AlgorithmState< Real >::ngrad, ROL::Vector< Real >::norm(), ROL::Vector< Real >::plus(), ROL::InteriorPointStep< Real >::rho_, ROL::AlgorithmState< Real >::snorm, and ROL::AlgorithmState< Real >::value.

Referenced by ROL::InteriorPointStep< Real >::update().

◆ update() [2/3]

template<class Real >

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

inlinevirtual

Update step, if successful (equality constraints).

Reimplemented from ROL::Step< Real >.

Definition at line 288 of file ROL_InteriorPointStep.hpp.

References ROL::InteriorPointStep< Real >::update().

◆ compute() [3/3]

template<class Real >

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

inlinevirtual

Compute step for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring.

Reimplemented from ROL::Step< Real >.

Definition at line 300 of file ROL_InteriorPointStep.hpp.

◆ update() [3/3]

template<class Real >

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

inlinevirtual

Update step, for bound constraints; here only to satisfy the interface requirements, does nothing, needs refactoring.

Reimplemented from ROL::Step< Real >.

Definition at line 307 of file ROL_InteriorPointStep.hpp.

◆ printHeader()

template<class Real >

std::string ROL::InteriorPointStep< Real >::printHeader ( void ) const

inlinevirtual

Print iterate header.

Reimplemented from ROL::Step< Real >.

Definition at line 313 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::print().

◆ printName()

template<class Real >

std::string ROL::InteriorPointStep< Real >::printName ( void ) const

inlinevirtual

Print step name.

Reimplemented from ROL::Step< Real >.

Definition at line 354 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::print().

◆ print()

template<class Real >

std::string ROL::InteriorPointStep< Real >::print	(	AlgorithmState< Real > &	algo_state,
		bool	pHeader = `false`
	)		const

inlinevirtual

Print iterate status.

Reimplemented from ROL::Step< Real >.

Definition at line 362 of file ROL_InteriorPointStep.hpp.

References ROL::AlgorithmState< Real >::cnorm, ROL::AlgorithmState< Real >::gnorm, ROL::AlgorithmState< Real >::iter, ROL::InteriorPointStep< Real >::mu_, ROL::AlgorithmState< Real >::ncval, ROL::AlgorithmState< Real >::nfval, ROL::AlgorithmState< Real >::ngrad, ROL::InteriorPointStep< Real >::printHeader(), ROL::InteriorPointStep< Real >::printName(), ROL::AlgorithmState< Real >::snorm, ROL::InteriorPointStep< Real >::subproblemIter_, and ROL::AlgorithmState< Real >::value.

Member Data Documentation

◆ OPT

template<class Real >

const size_type ROL::InteriorPointStep< Real >::OPT = 0

staticprivate

Definition at line 65 of file ROL_InteriorPointStep.hpp.

◆ SLACK

template<class Real >

const size_type ROL::InteriorPointStep< Real >::SLACK = 1

staticprivate

Definition at line 66 of file ROL_InteriorPointStep.hpp.

◆ status_

template<class Real >

Teuchos::RCP<StatusTest<Real> > ROL::InteriorPointStep< Real >::status_

private

Definition at line 70 of file ROL_InteriorPointStep.hpp.

◆ step_

template<class Real >

Teuchos::RCP<Step<Real> > ROL::InteriorPointStep< Real >::step_

private

Definition at line 71 of file ROL_InteriorPointStep.hpp.

◆ ipobj_

template<class Real >

Teuchos::RCP<IPOBJ> ROL::InteriorPointStep< Real >::ipobj_

private

Definition at line 72 of file ROL_InteriorPointStep.hpp.

◆ ipcon_

template<class Real >

Teuchos::RCP<IPCON> ROL::InteriorPointStep< Real >::ipcon_

private

Definition at line 73 of file ROL_InteriorPointStep.hpp.

◆ algo_

template<class Real >

Teuchos::RCP<Algorithm<Real> > ROL::InteriorPointStep< Real >::algo_

private

Definition at line 74 of file ROL_InteriorPointStep.hpp.

◆ parlist_

template<class Real >

Teuchos::RCP<Teuchos::ParameterList> ROL::InteriorPointStep< Real >::parlist_

private

Definition at line 75 of file ROL_InteriorPointStep.hpp.

◆ x_

template<class Real >

Teuchos::RCP<PV> ROL::InteriorPointStep< Real >::x_

private

Definition at line 78 of file ROL_InteriorPointStep.hpp.

◆ g_

template<class Real >

Teuchos::RCP<Vector<Real> > ROL::InteriorPointStep< Real >::g_

private

Definition at line 79 of file ROL_InteriorPointStep.hpp.

◆ l_

template<class Real >

Teuchos::RCP<Vector<Real> > ROL::InteriorPointStep< Real >::l_

private

Definition at line 80 of file ROL_InteriorPointStep.hpp.

◆ c_

template<class Real >

Teuchos::RCP<Vector<Real> > ROL::InteriorPointStep< Real >::c_

private

Definition at line 81 of file ROL_InteriorPointStep.hpp.

◆ mu_

template<class Real >

Real ROL::InteriorPointStep< Real >::mu_

private

Definition at line 83 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::print().

◆ mumin_

template<class Real >

Real ROL::InteriorPointStep< Real >::mumin_

private

Definition at line 84 of file ROL_InteriorPointStep.hpp.

◆ mumax_

template<class Real >

Real ROL::InteriorPointStep< Real >::mumax_

private

Definition at line 85 of file ROL_InteriorPointStep.hpp.

◆ rho_

template<class Real >

Real ROL::InteriorPointStep< Real >::rho_

private

Definition at line 86 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::update().

◆ maxit_

template<class Real >

int ROL::InteriorPointStep< Real >::maxit_

private

Definition at line 87 of file ROL_InteriorPointStep.hpp.

◆ gtol_

template<class Real >

Real ROL::InteriorPointStep< Real >::gtol_

private

Definition at line 90 of file ROL_InteriorPointStep.hpp.

◆ ctol_

template<class Real >

Real ROL::InteriorPointStep< Real >::ctol_

private

Definition at line 91 of file ROL_InteriorPointStep.hpp.

◆ stol_

template<class Real >

Real ROL::InteriorPointStep< Real >::stol_

private

Definition at line 92 of file ROL_InteriorPointStep.hpp.

◆ subproblemIter_

template<class Real >

int ROL::InteriorPointStep< Real >::subproblemIter_

private

Definition at line 93 of file ROL_InteriorPointStep.hpp.

Referenced by ROL::InteriorPointStep< Real >::print().

◆ verbosity_

template<class Real >

int ROL::InteriorPointStep< Real >::verbosity_

private

Definition at line 95 of file ROL_InteriorPointStep.hpp.

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

ROL_InteriorPointStep.hpp

Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

template<class Real> class ROL::InteriorPointStep< Real >

Member Typedef Documentation

◆ IPOBJ

◆ IPCON

◆ PV

◆ size_type

Constructor & Destructor Documentation

◆ ~InteriorPointStep()

◆ InteriorPointStep()

Member Function Documentation

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ compute() [1/3]

◆ compute() [2/3]

◆ update() [1/3]

◆ update() [2/3]

◆ compute() [3/3]

◆ update() [3/3]

◆ printHeader()

◆ printName()

◆ print()

Member Data Documentation

◆ OPT

◆ SLACK

◆ status_

◆ step_

◆ ipobj_

◆ ipcon_

◆ algo_

◆ parlist_

◆ x_

◆ g_

◆ l_

◆ c_

◆ mu_

◆ mumin_

◆ mumax_

◆ rho_

◆ maxit_

◆ gtol_

◆ ctol_

◆ stol_

◆ subproblemIter_

◆ verbosity_

template<class Real>
class ROL::InteriorPointStep< Real >