Ipopt::PDSearchDirCalculator Class Reference

Implementation of the search direction calculator that computes the pure primal dual step for the current barrier parameter. More...

#include <IpPDSearchDirCalc.hpp>

Inheritance diagram for Ipopt::PDSearchDirCalculator:

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	overloaded from AlgorithmStrategyObject
virtual bool	ComputeSearchDirection ()
	Method for computing the search direction.
SmartPtr< PDSystemSolver >	PDSolver ()
	Returns the pd_solver for additional processing.
Constructors/Destructors
	PDSearchDirCalculator (const SmartPtr< PDSystemSolver > &pd_solver)
	Constructor.
virtual	~PDSearchDirCalculator ()
	Destructor.
Public Member Functions inherited from Ipopt::SearchDirectionCalculator
	SearchDirectionCalculator ()
	Constructor.
virtual	~SearchDirectionCalculator ()
	Destructor.
Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
bool	Initialize (const Journalist &jnlst, IpoptNLP &ip_nlp, IpoptData &ip_data, IpoptCalculatedQuantities &ip_cq, const OptionsList &options, const std::string &prefix)
	This method is called every time the algorithm starts again - it is used to reset any internal state.
bool	ReducedInitialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
	Reduced version of the Initialize method, which does not require special Ipopt information.
	AlgorithmStrategyObject ()
	Default Constructor.
virtual	~AlgorithmStrategyObject ()
	Destructor.
Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()
virtual	~ReferencedObject ()
Index	ReferenceCount () const
void	AddRef (const Referencer *referencer) const
void	ReleaseRef (const Referencer *referencer) const

Static Public Member Functions
static void	RegisterOptions (const SmartPtr< RegisteredOptions > &roptions)

Private Member Functions
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	PDSearchDirCalculator ()
	Default Constructor.
	PDSearchDirCalculator (const PDSearchDirCalculator &)
	Copy Constructor.
void	operator= (const PDSearchDirCalculator &)
	Default Assignment Operator.

Private Attributes
Strategy objects
SmartPtr< PDSystemSolver >	pd_solver_
Algorithmic parameters
bool	fast_step_computation_
	Flag indicating that we trust that the steps from the linear solver are very good and that we don't need any residual checks.
bool	mehrotra_algorithm_
	Flag indicating if we want to do Mehrotras's algorithm.

Additional Inherited Members
Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const Journalist &	Jnlst () const
IpoptNLP &	IpNLP () const
IpoptData &	IpData () const
IpoptCalculatedQuantities &	IpCq () const
bool	HaveIpData () const

Detailed Description

Implementation of the search direction calculator that computes the pure primal dual step for the current barrier parameter.

Definition at line 19 of file IpPDSearchDirCalc.hpp.

Constructor & Destructor Documentation

PDSearchDirCalculator() [1/3]

Ipopt::PDSearchDirCalculator::PDSearchDirCalculator

(

const SmartPtr< PDSystemSolver > &

pd_solver

)

Constructor.

~PDSearchDirCalculator()

virtual Ipopt::PDSearchDirCalculator::~PDSearchDirCalculator ( )

virtual

Destructor.

PDSearchDirCalculator() [2/3]

Ipopt::PDSearchDirCalculator::PDSearchDirCalculator ( )

private

Default Constructor.

PDSearchDirCalculator() [3/3]

Ipopt::PDSearchDirCalculator::PDSearchDirCalculator ( const PDSearchDirCalculator &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

virtual bool Ipopt::PDSearchDirCalculator::InitializeImpl ( const OptionsList &  options, const std::string &  prefix  )

virtual

overloaded from AlgorithmStrategyObject

Implements Ipopt::SearchDirectionCalculator.

ComputeSearchDirection()

virtual bool Ipopt::PDSearchDirCalculator::ComputeSearchDirection ( )

virtual

Method for computing the search direction.

The computed direction is stored in IpData().delta().

Implements Ipopt::SearchDirectionCalculator.

RegisterOptions()

static void Ipopt::PDSearchDirCalculator::RegisterOptions ( const SmartPtr< RegisteredOptions > &  roptions )

static

PDSolver()

SmartPtr< PDSystemSolver > Ipopt::PDSearchDirCalculator::PDSolver ( )

inline

Returns the pd_solver for additional processing.

Definition at line 50 of file IpPDSearchDirCalc.hpp.

operator=()

void Ipopt::PDSearchDirCalculator::operator= ( const PDSearchDirCalculator &  )

private

Default Assignment Operator.

Member Data Documentation

pd_solver_

SmartPtr<PDSystemSolver> Ipopt::PDSearchDirCalculator::pd_solver_

private

Definition at line 82 of file IpPDSearchDirCalc.hpp.

fast_step_computation_

bool Ipopt::PDSearchDirCalculator::fast_step_computation_

private

Flag indicating that we trust that the steps from the linear solver are very good and that we don't need any residual checks.

Definition at line 90 of file IpPDSearchDirCalc.hpp.

mehrotra_algorithm_

bool Ipopt::PDSearchDirCalculator::mehrotra_algorithm_

private

Flag indicating if we want to do Mehrotras's algorithm.

This means that a number of options are ignored, or have to be set (or are automatically set) to certain values.

Definition at line 97 of file IpPDSearchDirCalc.hpp.

---

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

• src/Algorithm/IpPDSearchDirCalc.hpp