AlgorithmBuilder Class Reference

#include <IpAlgBuilder.hpp>

Inheritance diagram for AlgorithmBuilder:

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. 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.

Public Member Functions

Constructors/Destructors

AlgorithmBuilder ()

Constructor.

virtual ~AlgorithmBuilder ()

Destructor.

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< IpoptAlgorithm > BuildBasicAlgorithm (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)

Static Public Member Functions

static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)

Methods for IpoptTypeInfo.

Constructor & Destructor Documentation

AlgorithmBuilder ( ) [inline]

Constructor.

virtual ~AlgorithmBuilder ( ) [inline, virtual]

Destructor.

Member Function Documentation

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]`

References Ipopt::ConstPtr(), DBG_ASSERT, Ipopt::GetRawPtr(), and OptionsList::GetStringValue().

SmartPtr< IpoptAlgorithm > BuildBasicAlgorithm	(	const Journalist &	jnlst,
		const OptionsList &	options,
		const std::string &	prefix
	)			`[virtual]`

References DBG_START_FUN, Ipopt::EXACT, OptionsList::GetEnumValue(), Ipopt::GetRawPtr(), OptionsList::GetStringValue(), Ipopt::LIMITED_MEMORY, and THROW_EXCEPTION.

void RegisterOptions ( SmartPtr< RegisteredOptions > roptions ) [static]

Methods for IpoptTypeInfo.

register the options used by the algorithm builder

References HAVE_MC19.

Referenced by Ipopt::RegisterOptions_Algorithm().

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


Public Member Functions
Constructors/Destructors
	AlgorithmBuilder ()
	Constructor.
virtual	~AlgorithmBuilder ()
	Destructor.
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< IpoptAlgorithm >	BuildBasicAlgorithm (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
Static Public Member Functions

static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
	Methods for IpoptTypeInfo.