Public Member Functions | Protected Types
Ipopt::IterationOutput Class Reference

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

#include <IpIterationOutput.hpp>

Inheritance diagram for Ipopt::IterationOutput:
Ipopt::AlgorithmStrategyObject Ipopt::ReferencedObject Ipopt::OrigIterationOutput Ipopt::RestoIterationOutput

List of all members.

Public Member Functions

virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)=0
 overloaded from AlgorithmStrategyObject
virtual void WriteOutput ()=0
 Method to do all the summary output per iteration.
Constructors/Destructors
 IterationOutput ()
 Default Constructor.
virtual ~IterationOutput ()
 Default destructor.

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 &)
 Overloaded Equals Operator.

Detailed Description

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

Definition at line 22 of file IpIterationOutput.hpp.


Member Enumeration Documentation

enumeration for different inf_pr output options

Enumerator:
INTERNAL 
ORIGINAL 

Definition at line 47 of file IpIterationOutput.hpp.


Constructor & Destructor Documentation

Ipopt::IterationOutput::IterationOutput ( ) [inline]

Default Constructor.

Definition at line 28 of file IpIterationOutput.hpp.

virtual Ipopt::IterationOutput::~IterationOutput ( ) [inline, virtual]

Default destructor.

Definition at line 32 of file IpIterationOutput.hpp.

Ipopt::IterationOutput::IterationOutput ( const IterationOutput ) [private]

Copy Constructor.


Member Function Documentation

virtual bool Ipopt::IterationOutput::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
) [pure virtual]
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.

void Ipopt::IterationOutput::operator= ( const IterationOutput ) [private]

Overloaded Equals Operator.


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