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

Base class for computing the search direction for the line search. More...

#include <IpSearchDirCalculator.hpp>

+ Inheritance diagram for Ipopt::SearchDirectionCalculator:

Public Member Functions

virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)=0
 overloaded from AlgorithmStrategyObject More...
virtual bool ComputeSearchDirection ()=0
 Pure virtual method for computing the search direction. More...
 SearchDirectionCalculator ()
 Constructor. More...
virtual ~SearchDirectionCalculator ()
 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

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.

 SearchDirectionCalculator (const SearchDirectionCalculator &)
 Default Constructor. More...
void operator= (const SearchDirectionCalculator &)
 Overloaded Equals Operator. More...

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
IpoptNLPIpNLP () const
IpoptDataIpData () const
IpoptCalculatedQuantitiesIpCq () const
bool HaveIpData () const

Detailed Description

Base class for computing the search direction for the line search.

Definition at line 20 of file IpSearchDirCalculator.hpp.

Constructor & Destructor Documentation

Ipopt::SearchDirectionCalculator::SearchDirectionCalculator ( )


Definition at line 26 of file IpSearchDirCalculator.hpp.

virtual Ipopt::SearchDirectionCalculator::~SearchDirectionCalculator ( )

Default destructor.

Definition at line 30 of file IpSearchDirCalculator.hpp.

Ipopt::SearchDirectionCalculator::SearchDirectionCalculator ( const SearchDirectionCalculator )

Default Constructor.

Copy Constructor

Member Function Documentation

virtual bool Ipopt::SearchDirectionCalculator::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
pure virtual
virtual bool Ipopt::SearchDirectionCalculator::ComputeSearchDirection ( )
pure virtual

Pure virtual method for computing the search direction.

The computed direction is stored in IpData().delta().

Implemented in Ipopt::InexactSearchDirCalculator, Ipopt::CGSearchDirCalculator, and Ipopt::PDSearchDirCalculator.

void Ipopt::SearchDirectionCalculator::operator= ( const SearchDirectionCalculator )

Overloaded Equals Operator.

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