Ipopt::IpoptApplication Class Reference

This is the main application class for making calls to Ipopt. More...

#include <IpIpoptApplication.hpp>

Inheritance diagram for Ipopt::IpoptApplication:

[legend]

Collaboration diagram for Ipopt::IpoptApplication:

[legend]

List of all members.

Public Member Functions
	IpoptApplication (bool create_console_out=true, bool create_empty=false)
	IpoptApplication (SmartPtr< RegisteredOptions > reg_options, SmartPtr< OptionsList > options, SmartPtr< Journalist > jnlst)
	Another constructor that assumes that the code in the (default) constructor has already been executed.
virtual	~IpoptApplication ()
SmartPtr< IpoptApplication >	clone ()
	Method for creating a new IpoptApplication that uses the same journalist and registered options, and a copy of the options list.
ApplicationReturnStatus	Initialize (std::string params_file="ipopt.opt")
	Initialize method.
ApplicationReturnStatus	Initialize (std::istream &is)
bool	OpenOutputFile (std::string file_name, EJournalLevel print_level)
	Method for opening an output file with given print_level.
Solve methods

ApplicationReturnStatus	OptimizeTNLP (const SmartPtr< TNLP > &tnlp)
	Solve a problem that inherits from TNLP.
ApplicationReturnStatus	OptimizeNLP (const SmartPtr< NLP > &nlp)
	Solve a problem that inherits from NLP.
ApplicationReturnStatus	OptimizeNLP (const SmartPtr< NLP > &nlp, SmartPtr< AlgorithmBuilder > &alg_builder)
	Solve a problem that inherits from NLP.
ApplicationReturnStatus	ReOptimizeTNLP (const SmartPtr< TNLP > &tnlp)
	Solve a problem (that inherits from TNLP) for a repeated time.
ApplicationReturnStatus	ReOptimizeNLP (const SmartPtr< NLP > &nlp)
	Solve a problem (that inherits from NLP) for a repeated time.
Accessor methods

SmartPtr< Journalist >	Jnlst ()
	Get the Journalist for printing output.
SmartPtr< RegisteredOptions >	RegOptions ()
	Get a pointer to RegisteredOptions object to add new options.
SmartPtr< OptionsList >	Options ()
	Get the options list for setting options.
SmartPtr< const OptionsList >	Options () const
	Get the options list for setting options (const version).
SmartPtr< SolveStatistics >	Statistics ()
	Get the object with the statistics about the most recent optimization run.
Static Public Member Functions
static void	RegisterAllIpoptOptions (const SmartPtr< RegisteredOptions > &roptions)
	Method to registering all Ipopt options.
Methods for IpoptTypeInfo

static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)
Private Member Functions
ApplicationReturnStatus	call_optimize ()
	Method for the actual optimize call of the Ipopt algorithm.
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.
	IpoptApplication (const IpoptApplication &)
	Default Constructor.
void	operator= (const IpoptApplication &)
	Overloaded Equals Operator.
Private Attributes
SmartPtr< Journalist >	jnlst_
	Journalist for reporting output.
SmartPtr< RegisteredOptions >	reg_options_
	RegisteredOptions.
SmartPtr< OptionsList >	options_
	OptionsList used for the application.
SmartPtr< SolveStatistics >	statistics_
	Object for storing statistics about the most recent optimization run.
SmartPtr< IpoptAlgorithm >	alg_
	Object with the algorithm sceleton.
SmartPtr< IpoptNLP >	ip_nlp_
	IpoptNLP Object for the NLP.
SmartPtr< IpoptData >	ip_data_
	IpoptData Object for the NLP.
SmartPtr < IpoptCalculatedQuantities >	ip_cq_
	IpoptCalculatedQuantities Object for the NLP.
SmartPtr< NLP >	nlp_adapter_
	Pointer to the TNLPAdapter used to convert the TNLP to an NLP.
Variables that customize the application behavior

bool	read_params_dat_
	Decide whether or not the ipopt.opt file should be read.

Detailed Description

This is the main application class for making calls to Ipopt.

Definition at line 35 of file IpIpoptApplication.hpp.

Constructor & Destructor Documentation

Ipopt::IpoptApplication::IpoptApplication	(	bool	create_console_out = `true`,
		bool	create_empty = `false`
	)

Ipopt::IpoptApplication::IpoptApplication	(	SmartPtr< RegisteredOptions >	reg_options,
		SmartPtr< OptionsList >	options,
		SmartPtr< Journalist >	jnlst
	)

Another constructor that assumes that the code in the (default) constructor has already been executed.

virtual Ipopt::IpoptApplication::~IpoptApplication ( ) [virtual]

Ipopt::IpoptApplication::IpoptApplication ( const IpoptApplication & ) [private]

Default Constructor.

Copy Constructor

Member Function Documentation

SmartPtr<IpoptApplication> Ipopt::IpoptApplication::clone ( )

Method for creating a new IpoptApplication that uses the same journalist and registered options, and a copy of the options list.

ApplicationReturnStatus Ipopt::IpoptApplication::Initialize ( std::string params_file = "ipopt.opt" )

Initialize method.

This method reads the params file and initializes the journalists. You should call this method at some point before the first optimize call. Note: you can skip the processing of a params file by setting params_file to "". It returns something other than Solve_Succeeded if there was a problem in the initialization (such as an invalid option).

ApplicationReturnStatus Ipopt::IpoptApplication::Initialize ( std::istream & is )

ApplicationReturnStatus Ipopt::IpoptApplication::OptimizeTNLP ( const SmartPtr< TNLP > & tnlp )

Solve a problem that inherits from TNLP.

ApplicationReturnStatus Ipopt::IpoptApplication::OptimizeNLP ( const SmartPtr< NLP > & nlp )

Solve a problem that inherits from NLP.

ApplicationReturnStatus Ipopt::IpoptApplication::OptimizeNLP	(	const SmartPtr< NLP > &	nlp,
		SmartPtr< AlgorithmBuilder > &	alg_builder
	)

Solve a problem that inherits from NLP.

ApplicationReturnStatus Ipopt::IpoptApplication::ReOptimizeTNLP ( const SmartPtr< TNLP > & tnlp )

Solve a problem (that inherits from TNLP) for a repeated time.

The OptimizeTNLP method must have been called before. The TNLP must be the same object, and the structure (number of variables and constraints and position of nonzeros in Jacobian and Hessian must be the same).

ApplicationReturnStatus Ipopt::IpoptApplication::ReOptimizeNLP ( const SmartPtr< NLP > & nlp )

Solve a problem (that inherits from NLP) for a repeated time.

The OptimizeNLP method must have been called before. The NLP must be the same object, and the structure (number of variables and constraints and position of nonzeros in Jacobian and Hessian must be the same).