Ipopt::OrigIterationOutput Class Reference

Class for the iteration summary output for the original NLP. More...

#include <IpOrigIterationOutput.hpp>

Inheritance diagram for Ipopt::OrigIterationOutput:

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 / Destructor
	OrigIterationOutput ()
	Default Constructor.
virtual	~OrigIterationOutput ()
	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

Static Public Member Functions
static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
	Methods for OptionsList.

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

Private Attributes
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 original NLP.

Definition at line 17 of file IpOrigIterationOutput.hpp.

Constructor & Destructor Documentation

OrigIterationOutput() [1/2]

Ipopt::OrigIterationOutput::OrigIterationOutput

(

)

Default Constructor.

~OrigIterationOutput()

virtual Ipopt::OrigIterationOutput::~OrigIterationOutput ( )

virtual

Destructor.

OrigIterationOutput() [2/2]

Ipopt::OrigIterationOutput::OrigIterationOutput ( const OrigIterationOutput &  )

private

Copy Constructor.

Member Function Documentation

InitializeImpl()

virtual bool Ipopt::OrigIterationOutput::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::OrigIterationOutput::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.

RegisterOptions()

static void Ipopt::OrigIterationOutput::RegisterOptions ( SmartPtr< RegisteredOptions >  roptions )

static

Methods for OptionsList.

operator=()

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

private

Overloaded Assignment Operator.

Member Data Documentation

print_info_string_

bool Ipopt::OrigIterationOutput::print_info_string_

private

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

Definition at line 72 of file IpOrigIterationOutput.hpp.

inf_pr_output_

InfPrOutput Ipopt::OrigIterationOutput::inf_pr_output_

private

Option indication what should be printed in inf_pr column.

Definition at line 75 of file IpOrigIterationOutput.hpp.

print_frequency_iter_

Index Ipopt::OrigIterationOutput::print_frequency_iter_

private

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

Definition at line 78 of file IpOrigIterationOutput.hpp.

print_frequency_time_

Number Ipopt::OrigIterationOutput::print_frequency_time_

private

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

Definition at line 81 of file IpOrigIterationOutput.hpp.

---

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

• src/Algorithm/IpOrigIterationOutput.hpp