Base class for additional calculated quantities that is special to a particular type of algorithm, such as the CG penalty function, or using iterative linear solvers. More...

#include <IpIpoptCalculatedQuantities.hpp>

Inheritance diagram for Ipopt::IpoptAdditionalCq:

Public Member Functions
virtual bool	Initialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)=0
	This method is called to initialize the global algorithmic parameters.

Constructors/Destructors
	IpoptAdditionalCq ()
	Default Constructor.

virtual	~IpoptAdditionalCq ()
	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.
	IpoptAdditionalCq (const IpoptAdditionalCq &)
	Copy Constructor.

void	operator= (const IpoptAdditionalCq &)
	Default Assignment Operator.

Detailed Description

Base class for additional calculated quantities that is special to a particular type of algorithm, such as the CG penalty function, or using iterative linear solvers.

The regular IpoptCalculatedQuantities object should be given a derivation of this base class when it is created.

Definition at line 39 of file IpIpoptCalculatedQuantities.hpp.

Constructor & Destructor Documentation

◆ IpoptAdditionalCq() [1/2]

Ipopt::IpoptAdditionalCq::IpoptAdditionalCq ( )

inline

Default Constructor.

Definition at line 45 of file IpIpoptCalculatedQuantities.hpp.

◆ ~IpoptAdditionalCq()

virtual Ipopt::IpoptAdditionalCq::~IpoptAdditionalCq ( )

inlinevirtual

Destructor.

Definition at line 49 of file IpIpoptCalculatedQuantities.hpp.

◆ IpoptAdditionalCq() [2/2]

Ipopt::IpoptAdditionalCq::IpoptAdditionalCq ( const IpoptAdditionalCq & )

private

Copy Constructor.

Member Function Documentation

◆ Initialize()

virtual bool Ipopt::IpoptAdditionalCq::Initialize	(	const Journalist &	jnlst,
		const OptionsList &	options,
		const std::string &	prefix
	)

pure virtual

This method is called to initialize the global algorithmic parameters.

The parameters are taken from the OptionsList object.

Implemented in Ipopt::InexactCq, and Ipopt::CGPenaltyCq.

◆ operator=()

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

private

Default Assignment Operator.

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

src/Algorithm/IpIpoptCalculatedQuantities.hpp

Public Member Functions

Private Member Functions