Ipopt::RestoIterationOutput Class Reference

Class for the iteration summary output for the restoration phase. More...

#include <IpRestoIterationOutput.hpp>

Inheritance diagram for Ipopt::RestoIterationOutput:

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	Implementation of the initialization method that has to be overloaded by for each derived class.
virtual void	WriteOutput ()
	Method to do all the summary output per iteration.
Constructors/Destructors
	RestoIterationOutput (const SmartPtr< OrigIterationOutput > &resto_orig_iteration_output)
	Constructor.
virtual	~RestoIterationOutput ()
	Destructor.
Public Member Functions inherited from Ipopt::IterationOutput
	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

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

Private Attributes
SmartPtr< OrigIterationOutput >	resto_orig_iteration_output_
	Pointer to output strategy object during regular iterations.
bool	print_info_string_
	Flag indicating weather info string should be printed at end of iteration summary line.
InfPrOutput	inf_pr_output_
	Option indication what should be printed in inf_pr column.
Index	print_frequency_iter_
	Option indicating at which iteration frequency the summary line should be printed.
Number	print_frequency_time_
	Option indicating at which time frequency the summary line should be printed.

Additional Inherited Members
Protected Types inherited from Ipopt::IterationOutput
enum	InfPrOutput { INTERNAL = 0 , ORIGINAL }
	enumeration for different inf_pr output options More...
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

Class for the iteration summary output for the restoration phase.

This prints information for the ORIGINAL NLP (and possibly for the restoration phase NLP).

Definition at line 21 of file IpRestoIterationOutput.hpp.

Constructor & Destructor Documentation

RestoIterationOutput() [1/3]

Ipopt::RestoIterationOutput::RestoIterationOutput

(

const SmartPtr< OrigIterationOutput > &

resto_orig_iteration_output

)

Constructor.

If resto_orig_iteration_output is not NULL, the output will be done twice per iteration, first for the restoration phase problem, and secondly using the functions for the original NLP.

~RestoIterationOutput()

virtual Ipopt::RestoIterationOutput::~RestoIterationOutput ( )

virtual

Destructor.

RestoIterationOutput() [2/3]

Ipopt::RestoIterationOutput::RestoIterationOutput ( )

private

Default Constructor.

RestoIterationOutput() [3/3]

Ipopt::RestoIterationOutput::RestoIterationOutput ( const RestoIterationOutput &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

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

virtual

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

Implements Ipopt::IterationOutput.

WriteOutput()

virtual void Ipopt::RestoIterationOutput::WriteOutput ( )

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.

Implements Ipopt::IterationOutput.

operator=()

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

private

Default Assignment Operator.

Member Data Documentation

resto_orig_iteration_output_

SmartPtr<OrigIterationOutput> Ipopt::RestoIterationOutput::resto_orig_iteration_output_

private

Pointer to output strategy object during regular iterations.

Definition at line 78 of file IpRestoIterationOutput.hpp.

print_info_string_

bool Ipopt::RestoIterationOutput::print_info_string_

private

Flag indicating weather info string should be printed at end of iteration summary line.

Definition at line 83 of file IpRestoIterationOutput.hpp.

inf_pr_output_

InfPrOutput Ipopt::RestoIterationOutput::inf_pr_output_

private

Option indication what should be printed in inf_pr column.

Definition at line 86 of file IpRestoIterationOutput.hpp.

print_frequency_iter_

Index Ipopt::RestoIterationOutput::print_frequency_iter_

private

Option indicating at which iteration frequency the summary line should be printed.

Definition at line 89 of file IpRestoIterationOutput.hpp.

print_frequency_time_

Number Ipopt::RestoIterationOutput::print_frequency_time_

private

Option indicating at which time frequency the summary line should be printed.

Definition at line 92 of file IpRestoIterationOutput.hpp.

---

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

• src/Algorithm/IpRestoIterationOutput.hpp