Base class for objects that do the output summary per iteration. More...

#include <IpIterationOutput.hpp>

Inheritance diagram for Ipopt::IterationOutput:

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)=0
	Implementation of the initialization method that has to be overloaded by for each derived class.

virtual void	WriteOutput ()=0
	Method to do all the summary output per iteration.

Constructors/Destructors
	IterationOutput ()
	Default Constructor.

virtual	~IterationOutput ()
	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

Protected Types
enum	InfPrOutput { INTERNAL = 0 , ORIGINAL }
	enumeration for different inf_pr output options More...

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.
	IterationOutput (const IterationOutput &)
	Copy Constructor.

void	operator= (const IterationOutput &)

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 do the output summary per iteration.

Definition at line 20 of file IpIterationOutput.hpp.

Member Enumeration Documentation

◆ InfPrOutput

enum Ipopt::IterationOutput::InfPrOutput

protected

enumeration for different inf_pr output options

Enumerator
INTERNAL
ORIGINAL

Definition at line 48 of file IpIterationOutput.hpp.

Constructor & Destructor Documentation

◆ IterationOutput() [1/2]

Ipopt::IterationOutput::IterationOutput ( )

inline

Default Constructor.

Definition at line 26 of file IpIterationOutput.hpp.

◆ ~IterationOutput()

virtual Ipopt::IterationOutput::~IterationOutput ( )

inlinevirtual

Destructor.

Definition at line 30 of file IpIterationOutput.hpp.

◆ IterationOutput() [2/2]

Ipopt::IterationOutput::IterationOutput ( const IterationOutput & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

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

pure virtual

Implementation of the initialization method that has to be overloaded by for each derived class.

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::OrigIterationOutput, and Ipopt::RestoIterationOutput.

◆ WriteOutput()

virtual void Ipopt::IterationOutput::WriteOutput ( )

pure virtual

Method to do all the summary output per iteration.

This include the one-line summary output as well as writing the details about the iterates if desired.

Implemented in Ipopt::OrigIterationOutput, and Ipopt::RestoIterationOutput.

◆ operator=()

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