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

Builder to create a complete IpoptAlg object for the inexact step computation version. More...

#include <IpInexactAlgBuilder.hpp>

+ Inheritance diagram for Ipopt::InexactAlgorithmBuilder:

Public Member Functions

Constructors/Destructors
 InexactAlgorithmBuilder ()
 Constructor. More...
 
virtual ~InexactAlgorithmBuilder ()
 Destructor. More...
 
- Public Member Functions inherited from Ipopt::AlgorithmBuilder
 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...
 
 InexactAlgorithmBuilder (const InexactAlgorithmBuilder &)
 Default Constructor. More...
 
void operator= (const InexactAlgorithmBuilder &)
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Ipopt::AlgorithmBuilder
static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 Methods for IpoptTypeInfo. More...
 

Detailed Description

Builder to create a complete IpoptAlg object for the inexact step computation version.

Definition at line 21 of file IpInexactAlgBuilder.hpp.

Constructor & Destructor Documentation

◆ InexactAlgorithmBuilder() [1/2]

Ipopt::InexactAlgorithmBuilder::InexactAlgorithmBuilder ( )

Constructor.

◆ ~InexactAlgorithmBuilder()

virtual Ipopt::InexactAlgorithmBuilder::~InexactAlgorithmBuilder ( )
inlinevirtual

Destructor.

Definition at line 30 of file IpInexactAlgBuilder.hpp.

◆ InexactAlgorithmBuilder() [2/2]

Ipopt::InexactAlgorithmBuilder::InexactAlgorithmBuilder ( const InexactAlgorithmBuilder )
private

Default Constructor.

Copy Constructor

Member Function Documentation

◆ BuildIpoptObjects()

virtual void Ipopt::InexactAlgorithmBuilder::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 from Ipopt::AlgorithmBuilder.

◆ BuildBasicAlgorithm()

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

Reimplemented from Ipopt::AlgorithmBuilder.

◆ RegisterOptions()

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

Methods for IpoptTypeInfo.

register the options used by the algorithm builder

◆ operator=()

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

Overloaded Equals Operator.

Member Data Documentation

◆ custom_solver_

SmartPtr<AugSystemSolver> Ipopt::InexactAlgorithmBuilder::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 78 of file IpInexactAlgBuilder.hpp.


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