Ipopt 3.12.10

- Main Page
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Types | List of all members
Ipopt::IterationOutput Class Referenceabstract

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

`#include <IpIterationOutput.hpp>`

Inheritance diagram for Ipopt::IterationOutput:
[legend]

## Public Member Functions
virtual bool | InitializeImpl (const OptionsList &options, const std::string &prefix)=0
| overloaded from AlgorithmStrategyObject More...
virtual void | WriteOutput ()=0
| Method to do all the summary output per iteration. More...
Constructors/Destructors
| IterationOutput ()
| Default Constructor. More...
virtual | ~IterationOutput ()
| Default destructor. More...
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. More...
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. More...
| AlgorithmStrategyObject ()
| Default Constructor. More...
virtual | ~AlgorithmStrategyObject ()
| Default Destructor. More...
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. More...
void | operator= (const IterationOutput &)
| Overloaded Equals Operator. More...

## 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 22 of file IpIterationOutput.hpp.

## Member Enumeration Documentation

enum Ipopt::IterationOutput::InfPrOutput
| protected

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

overloaded from AlgorithmStrategyObject

Implements Ipopt::AlgorithmStrategyObject.

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

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::RestoIterationOutput, and Ipopt::OrigIterationOutput.

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

Overloaded Equals Operator.

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

- src/Algorithm/IpIterationOutput.hpp