Ipopt::EqMultiplierCalculator Class Reference

Base Class for objects that compute estimates for the equality constraint multipliers y_c and y_d. More...

#include <IpEqMultCalculator.hpp>

Inheritance diagram for Ipopt::EqMultiplierCalculator:

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)=0
	overloaded from AlgorithmStrategyObject
virtual bool	CalculateMultipliers (Vector &y_c, Vector &y_d)=0
	This method computes the estimates for y_c and y_d at the current point.
Constructors/Destructors
	EqMultiplierCalculator ()
	Default Constructor.
virtual	~EqMultiplierCalculator ()
	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

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.
	EqMultiplierCalculator (const EqMultiplierCalculator &)
	Copy Constructor.
void	operator= (const EqMultiplierCalculator &)
	Default Assignment Operator.

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

Base Class for objects that compute estimates for the equality constraint multipliers y_c and y_d.

For example, this is the base class for objects for computing least square multipliers or coordinate multipliers.

Definition at line 21 of file IpEqMultCalculator.hpp.

Constructor & Destructor Documentation

EqMultiplierCalculator() [1/2]

Ipopt::EqMultiplierCalculator::EqMultiplierCalculator ( )

inline

Default Constructor.

Definition at line 27 of file IpEqMultCalculator.hpp.

~EqMultiplierCalculator()

virtual Ipopt::EqMultiplierCalculator::~EqMultiplierCalculator ( )

inlinevirtual

Destructor.

Definition at line 30 of file IpEqMultCalculator.hpp.

EqMultiplierCalculator() [2/2]

Ipopt::EqMultiplierCalculator::EqMultiplierCalculator ( const EqMultiplierCalculator &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

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

pure virtual

overloaded from AlgorithmStrategyObject

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::LeastSquareMultipliers.

CalculateMultipliers()

virtual bool Ipopt::EqMultiplierCalculator::CalculateMultipliers ( Vector &  y_c, Vector &  y_d  )

pure virtual

This method computes the estimates for y_c and y_d at the current point.

If the estimates cannot be computed (e.g. some linear system is singular), the return value of this method is false.

Implemented in Ipopt::LeastSquareMultipliers.

operator=()

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

private

Default Assignment Operator.

---

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

• src/Algorithm/IpEqMultCalculator.hpp