Ipopt  3.11.9
List of all members
Ipopt::AlgorithmBuilder Class Reference

Builder to create a complete IpoptAlg object. More...

#include <IpAlgBuilder.hpp>

+ Inheritance diagram for Ipopt::AlgorithmBuilder:

Public Member Functions

Constructors/Destructors
 AlgorithmBuilder (SmartPtr< AugSystemSolver > custom_solver=NULL)
 Constructor. More...
 
virtual ~AlgorithmBuilder ()
 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
 

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.

SmartPtr< AugSystemSolvercustom_solver_
 Optional pointer to AugSystemSolver. More...
 
 AlgorithmBuilder (const AlgorithmBuilder &)
 Default Constructor. More...
 
void operator= (const AlgorithmBuilder &)
 Overloaded Equals Operator. More...
 

Methods to build parts of the algorithm

virtual void BuildIpoptObjects (const Journalist &jnlst, const OptionsList &options, const std::string &prefix, const SmartPtr< NLP > &nlp, SmartPtr< IpoptNLP > &ip_nlp, SmartPtr< IpoptData > &ip_data, SmartPtr< IpoptCalculatedQuantities > &ip_cq)
 
virtual SmartPtr< IpoptAlgorithmBuildBasicAlgorithm (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
 
static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 Methods for IpoptTypeInfo. More...
 

Detailed Description

Builder to create a complete IpoptAlg object.

This object contains all subelements (such as line search objects etc). How the resulting IpoptAlg object is built can be influenced by the options.

The optional argument custom_solver allows the expert user to provide a specialized linear solver (e.g., of the type GenAugSystemSolver), possibly for selfmade matrix objects.

TODO: Currently, this is a basic implementation with everything in one method that can be overloaded. This will need to be expanded to allow customization of different parts without recoding everything.

Definition at line 32 of file IpAlgBuilder.hpp.

Constructor & Destructor Documentation

◆ AlgorithmBuilder() [1/2]

Ipopt::AlgorithmBuilder::AlgorithmBuilder ( SmartPtr< AugSystemSolver custom_solver = NULL)

Constructor.

◆ ~AlgorithmBuilder()

virtual Ipopt::AlgorithmBuilder::~AlgorithmBuilder ( )
inlinevirtual

Destructor.

Definition at line 41 of file IpAlgBuilder.hpp.

◆ AlgorithmBuilder() [2/2]

Ipopt::AlgorithmBuilder::AlgorithmBuilder ( const AlgorithmBuilder )
private

Default Constructor.

Copy Constructor

Member Function Documentation

◆ BuildIpoptObjects()

virtual void Ipopt::AlgorithmBuilder::BuildIpoptObjects ( const Journalist jnlst,
const OptionsList options,
const std::string &  prefix,
const SmartPtr< NLP > &  nlp,
SmartPtr< IpoptNLP > &  ip_nlp,
SmartPtr< IpoptData > &  ip_data,
SmartPtr< IpoptCalculatedQuantities > &  ip_cq 
)
virtual

Reimplemented in Ipopt::InexactAlgorithmBuilder.

◆ BuildBasicAlgorithm()

virtual SmartPtr<IpoptAlgorithm> Ipopt::AlgorithmBuilder::BuildBasicAlgorithm ( const Journalist jnlst,
const OptionsList options,
const std::string &  prefix 
)
virtual

Reimplemented in Ipopt::InexactAlgorithmBuilder.

◆ RegisterOptions()

static void Ipopt::AlgorithmBuilder::RegisterOptions ( SmartPtr< RegisteredOptions roptions)
static

Methods for IpoptTypeInfo.

register the options used by the algorithm builder

◆ operator=()

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

Overloaded Equals Operator.

Member Data Documentation

◆ custom_solver_

SmartPtr<AugSystemSolver> Ipopt::AlgorithmBuilder::custom_solver_
private

Optional pointer to AugSystemSolver.

If this is set in the contructor, we will use this to solver the linear systems if the option linear_solver=custerm is chosen.

Definition at line 89 of file IpAlgBuilder.hpp.


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