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

Base class for additional data that is special to a particular type of algorithm, such as the CG penalty function, or using iterative linear solvers. More...

#include <IpIpoptData.hpp>

+ Inheritance diagram for Ipopt::IpoptAdditionalData:

Public Member Functions

virtual bool Initialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)=0
 This method is called to initialize the global algorithmic parameters. More...
 
virtual bool InitializeDataStructures ()=0
 Initialize Data Structures at the beginning. More...
 
virtual void AcceptTrialPoint ()=0
 Do whatever is necessary to accept a trial point as current iterate. More...
 
Constructors/Destructors
 IpoptAdditionalData ()
 Default Constructor. More...
 
virtual ~IpoptAdditionalData ()
 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
 

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.

 IpoptAdditionalData (const IpoptAdditionalData &)
 Copy Constructor. More...
 
void operator= (const IpoptAdditionalData &)
 Overloaded Equals Operator. More...
 

Detailed Description

Base class for additional data that is special to a particular type of algorithm, such as the CG penalty function, or using iterative linear solvers.

The regular IpoptData object should be given a derivation of this base class when it is created.

Definition at line 28 of file IpIpoptData.hpp.

Constructor & Destructor Documentation

Ipopt::IpoptAdditionalData::IpoptAdditionalData ( )
inline

Default Constructor.

Definition at line 34 of file IpIpoptData.hpp.

virtual Ipopt::IpoptAdditionalData::~IpoptAdditionalData ( )
inlinevirtual

Default destructor.

Definition at line 38 of file IpIpoptData.hpp.

Ipopt::IpoptAdditionalData::IpoptAdditionalData ( const IpoptAdditionalData )
private

Copy Constructor.

Member Function Documentation

virtual bool Ipopt::IpoptAdditionalData::Initialize ( const Journalist jnlst,
const OptionsList options,
const std::string &  prefix 
)
pure virtual

This method is called to initialize the global algorithmic parameters.

The parameters are taken from the OptionsList object.

Implemented in Ipopt::CGPenaltyData, and Ipopt::InexactData.

virtual bool Ipopt::IpoptAdditionalData::InitializeDataStructures ( )
pure virtual

Initialize Data Structures at the beginning.

Implemented in Ipopt::CGPenaltyData, and Ipopt::InexactData.

virtual void Ipopt::IpoptAdditionalData::AcceptTrialPoint ( )
pure virtual

Do whatever is necessary to accept a trial point as current iterate.

This is also used to finish an iteration, i.e., to release memory, and to reset any flags for a new iteration.

Implemented in Ipopt::CGPenaltyData, and Ipopt::InexactData.

void Ipopt::IpoptAdditionalData::operator= ( const IpoptAdditionalData )
private

Overloaded Equals Operator.


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