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

#include <IpIpoptApplication.hpp>

Inheritance diagram for Ipopt::IpoptApplication:

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 ()

virtual SmartPtr< IpoptApplication >	clone ()
	Method for creating a new IpoptApplication that uses the same journalist and registered options, and a copy of the options list.

virtual ApplicationReturnStatus	Initialize (std::istream &is, bool allow_clobber=false)
	Initialization method.

virtual ApplicationReturnStatus	Initialize (std::string params_file, bool allow_clobber=false)
	Initialization method.

virtual ApplicationReturnStatus	Initialize (const char *params_file, bool allow_clobber=false)
	Initialization method.

virtual ApplicationReturnStatus	Initialize (bool allow_clobber=false)
	Initialize method.

virtual bool	OpenOutputFile (std::string file_name, EJournalLevel print_level, bool file_append=false)
	Method for opening an output file with given print_level.

void	PrintCopyrightMessage ()
	Method for printing Ipopt copyright message now instead of just before the optimization.

bool	RethrowNonIpoptException (bool dorethrow)
	Method to set whether non-ipopt non-bad_alloc non-overflow_error exceptions are rethrown by Ipopt.

Solve methods
virtual ApplicationReturnStatus	OptimizeTNLP (const SmartPtr< TNLP > &tnlp)
	Solve a problem that inherits from TNLP.

virtual ApplicationReturnStatus	OptimizeNLP (const SmartPtr< NLP > &nlp)
	Solve a problem that inherits from NLP.

virtual ApplicationReturnStatus	OptimizeNLP (const SmartPtr< NLP > &nlp, SmartPtr< AlgorithmBuilder > &alg_builder)
	Solve a problem that inherits from NLP.

virtual ApplicationReturnStatus	ReOptimizeTNLP (const SmartPtr< TNLP > &tnlp)
	Solve a problem (that inherits from TNLP) for a repeated time.

virtual ApplicationReturnStatus	ReOptimizeNLP (const SmartPtr< NLP > &nlp)
	Solve a problem (that inherits from NLP) for a repeated time.

Accessor methods
virtual SmartPtr< Journalist >	Jnlst ()
	Get the Journalist for printing output.

virtual SmartPtr< RegisteredOptions >	RegOptions ()
	Get a pointer to RegisteredOptions object to add new options.

virtual SmartPtr< OptionsList >	Options ()
	Get the options list for setting options.

virtual SmartPtr< const OptionsList >	Options () const
	Get the options list for setting options (const version)

virtual SmartPtr< SolveStatistics >	Statistics ()
	Get the object with the statistics about the most recent optimization run.

virtual SmartPtr< IpoptNLP >	IpoptNLPObject ()
	Get the IpoptNLP Object.

SmartPtr< IpoptData >	IpoptDataObject ()
	Get the IpoptData Object.

virtual SmartPtr< IpoptCalculatedQuantities >	IpoptCQObject ()
	Get the IpoptCQ Object.

SmartPtr< IpoptAlgorithm >	AlgorithmObject ()
	Get the Algorithm Object.

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

Static Public Member Functions
static void	RegisterOptions (SmartPtr< RegisteredOptions > roptions)

static void	RegisterAllIpoptOptions (const SmartPtr< RegisteredOptions > &roptions)
	Method to register all Ipopt options.

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 &)
	Copy Constructor.

void	operator= (const IpoptApplication &)
	Default Assignment 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 skeleton.

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.

bool	rethrow_nonipoptexception_
	Decide whether non-ipopt non-bad_alloc non-overflow_error exceptions should be rethrown.

Algorithmic parameters
bool	inexact_algorithm_
	Flag indicating if we are to use the inexact linear solver option.

bool	replace_bounds_
	Flag indicating if all bounds should be replaced by inequality constraints.

Detailed Description

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

Definition at line 32 of file IpIpoptApplication.hpp.

Constructor & Destructor Documentation

◆ IpoptApplication() [1/3]

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

◆ IpoptApplication() [2/3]

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.

◆ ~IpoptApplication()

virtual Ipopt::IpoptApplication::~IpoptApplication ( )

virtual

◆ IpoptApplication() [3/3]

Ipopt::IpoptApplication::IpoptApplication ( const IpoptApplication & )

private

Copy Constructor.

Member Function Documentation

◆ clone()

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

virtual

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

◆ Initialize() [1/4]

virtual ApplicationReturnStatus Ipopt::IpoptApplication::Initialize	(	std::istream &	is,
		bool	allow_clobber = `false`
	)

virtual

Initialization method.

This method reads options from the input stream and initializes the journalists.

Returns: Solve_Succeeded or something else if there was a problem in the initialization (such as an invalid option).

You should call one of the initialization methods at some point before the first optimize call. Set

allow_clobber to true if you want to allow: overwriting options that are set by the input stream.

◆ Initialize() [2/4]

virtual ApplicationReturnStatus Ipopt::IpoptApplication::Initialize	(	std::string	params_file,
		bool	allow_clobber = `false`
	)

virtual

Initialization method.

This method reads options from the params file and initializes the journalists.

Returns: Solve_Succeeded or something else if there was a problem in the initialization (such as an invalid option).

You should call one of the initialization methods at some point before the first optimize call.

Note: You can skip the processing of a params file by setting params_file to "".

Set

allow_clobber to true if you want to allow: overwriting options that are set by the params file.

◆ Initialize() [3/4]

virtual ApplicationReturnStatus Ipopt::IpoptApplication::Initialize	(	const char *	params_file,
		bool	allow_clobber = `false`
	)

inlinevirtual

Initialization method.

This method reads options from the params file and initializes the journalists.

Returns: Solve_Succeeded or something else if there was a problem in the initialization (such as an invalid option).

You should call one of the initialization methods at some point before the first optimize call.

Note: You can skip the processing of a params file by setting params_file to "".

Set

allow_clobber to true if you want to allow: overwriting options that are set by the params file.

Definition at line 113 of file IpIpoptApplication.hpp.

◆ Initialize() [4/4]

virtual ApplicationReturnStatus Ipopt::IpoptApplication::Initialize ( bool allow_clobber = false )

virtual

Initialize method.

This method reads the options file specified by the option_file_name option and initializes the journalists.

Returns: Solve_Succeeded or something else if there was a problem in the initialization (such as an invalid option).

You should call this method at some point before the first optimize call.

Set

allow_clobber to true if you want to allow: overwriting options that are set by the options file.

◆ OptimizeTNLP()

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

virtual

Solve a problem that inherits from TNLP.

◆ OptimizeNLP() [1/2]

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

virtual

Solve a problem that inherits from NLP.

◆ OptimizeNLP() [2/2]

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

virtual

Solve a problem that inherits from NLP.

◆ ReOptimizeTNLP()

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

virtual

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. The IpoptAlgorithm object from the previous solve will be reused.

◆ ReOptimizeNLP()

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

virtual

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. The IpoptAlgorithm object from the previous solve will be reused.

◆ OpenOutputFile()

virtual bool Ipopt::IpoptApplication::OpenOutputFile	(	std::string	file_name,
		EJournalLevel	print_level,
		bool	file_append = `false`
	)

virtual

Method for opening an output file with given print_level.

Returns: false if there was a problem

Parameters

file_name	name of file to open
print_level	print level to be used
file_append	whether to append to file or truncate (since 3.14.13)

◆ Jnlst()

virtual SmartPtr< Journalist > Ipopt::IpoptApplication::Jnlst ( )

inlinevirtual

Get the Journalist for printing output.

Definition at line 191 of file IpIpoptApplication.hpp.

◆ RegOptions()

virtual SmartPtr< RegisteredOptions > Ipopt::IpoptApplication::RegOptions ( )

inlinevirtual

Get a pointer to RegisteredOptions object to add new options.

Definition at line 197 of file IpIpoptApplication.hpp.

◆ Options() [1/2]

virtual SmartPtr< OptionsList > Ipopt::IpoptApplication::Options ( )

inlinevirtual

Get the options list for setting options.

Definition at line 203 of file IpIpoptApplication.hpp.

◆ Options() [2/2]

virtual SmartPtr< const OptionsList > Ipopt::IpoptApplication::Options ( ) const

inlinevirtual

Get the options list for setting options (const version)

Definition at line 209 of file IpIpoptApplication.hpp.

◆ Statistics()

virtual SmartPtr< SolveStatistics > Ipopt::IpoptApplication::Statistics ( )

virtual

Get the object with the statistics about the most recent optimization run.

Note: Statistics are not available if optimization terminated with a serious problem, that is, an ApplicationReturnStatus of Not_Enough_Degrees_Of_Freedom or lower.

◆ IpoptNLPObject()

virtual SmartPtr< IpoptNLP > Ipopt::IpoptApplication::IpoptNLPObject ( )

virtual

Get the IpoptNLP Object.

◆ IpoptDataObject()

SmartPtr< IpoptData > Ipopt::IpoptApplication::IpoptDataObject ( )

Get the IpoptData Object.

◆ IpoptCQObject()

virtual SmartPtr< IpoptCalculatedQuantities > Ipopt::IpoptApplication::IpoptCQObject ( )

virtual

Get the IpoptCQ Object.

◆ AlgorithmObject()

SmartPtr< IpoptAlgorithm > Ipopt::IpoptApplication::AlgorithmObject ( )

Get the Algorithm Object.

◆ PrintCopyrightMessage()

void Ipopt::IpoptApplication::PrintCopyrightMessage ( )

Method for printing Ipopt copyright message now instead of just before the optimization.

If you want to have the copy right message printed earlier than by default, call this method at the convenient time.

◆ RethrowNonIpoptException()

bool Ipopt::IpoptApplication::RethrowNonIpoptException ( bool dorethrow )

inline

Method to set whether non-ipopt non-bad_alloc non-overflow_error exceptions are rethrown by Ipopt.

By default, non-Ipopt and non-bad_alloc and non-overflow_error exceptions are caught by Ipopts initialization and optimization methods and the status NonIpopt_Exception_Thrown is returned. This function allows to enable rethrowing of such exceptions.

Returns: Returns whether non-ipopt exceptions were rethrown before.

Definition at line 254 of file IpIpoptApplication.hpp.

◆ RegisterOptions()

static void Ipopt::IpoptApplication::RegisterOptions ( SmartPtr< RegisteredOptions > roptions )

static

◆ RegisterAllIpoptOptions()

static void Ipopt::IpoptApplication::RegisterAllIpoptOptions ( const SmartPtr< RegisteredOptions > & roptions )

static

Method to register all Ipopt options.

◆ operator=()

void Ipopt::IpoptApplication::operator= ( const IpoptApplication & )

private

Default Assignment Operator.

◆ call_optimize()

ApplicationReturnStatus Ipopt::IpoptApplication::call_optimize ( )

private

Method for the actual optimize call of the Ipopt algorithm.

This is used both for Optimize and ReOptimize

Member Data Documentation

◆ read_params_dat_

bool Ipopt::IpoptApplication::read_params_dat_

private

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

Definition at line 302 of file IpIpoptApplication.hpp.

◆ rethrow_nonipoptexception_

bool Ipopt::IpoptApplication::rethrow_nonipoptexception_

private

Decide whether non-ipopt non-bad_alloc non-overflow_error exceptions should be rethrown.

Definition at line 305 of file IpIpoptApplication.hpp.

◆ jnlst_

SmartPtr<Journalist> Ipopt::IpoptApplication::jnlst_

private

Journalist for reporting output.

Definition at line 309 of file IpIpoptApplication.hpp.

◆ reg_options_

SmartPtr<RegisteredOptions> Ipopt::IpoptApplication::reg_options_

private

RegisteredOptions.

Definition at line 312 of file IpIpoptApplication.hpp.

◆ options_

SmartPtr<OptionsList> Ipopt::IpoptApplication::options_

private

OptionsList used for the application.

Definition at line 315 of file IpIpoptApplication.hpp.

◆ statistics_

SmartPtr<SolveStatistics> Ipopt::IpoptApplication::statistics_

private

Object for storing statistics about the most recent optimization run.

Definition at line 320 of file IpIpoptApplication.hpp.

◆ alg_

SmartPtr<IpoptAlgorithm> Ipopt::IpoptApplication::alg_

private

Object with the algorithm skeleton.

Definition at line 324 of file IpIpoptApplication.hpp.

◆ ip_nlp_

SmartPtr<IpoptNLP> Ipopt::IpoptApplication::ip_nlp_

private

IpoptNLP Object for the NLP.

We keep this around for a ReOptimize warm start.

Definition at line 330 of file IpIpoptApplication.hpp.

◆ ip_data_

SmartPtr<IpoptData> Ipopt::IpoptApplication::ip_data_

private

IpoptData Object for the NLP.

We keep this around for a ReOptimize warm start.

Definition at line 336 of file IpIpoptApplication.hpp.

◆ ip_cq_

SmartPtr<IpoptCalculatedQuantities> Ipopt::IpoptApplication::ip_cq_

private

IpoptCalculatedQuantities Object for the NLP.

We keep this around for a ReOptimize warm start.

Definition at line 342 of file IpIpoptApplication.hpp.

◆ nlp_adapter_

SmartPtr<NLP> Ipopt::IpoptApplication::nlp_adapter_

private

Pointer to the TNLPAdapter used to convert the TNLP to an NLP.

We keep this around for the ReOptimizerTNLP call.

Definition at line 348 of file IpIpoptApplication.hpp.

◆ inexact_algorithm_

bool Ipopt::IpoptApplication::inexact_algorithm_

private

Flag indicating if we are to use the inexact linear solver option.

Definition at line 353 of file IpIpoptApplication.hpp.

◆ replace_bounds_

bool Ipopt::IpoptApplication::replace_bounds_

private

Flag indicating if all bounds should be replaced by inequality constraints.

This is necessary for the inexact algorithm.

Definition at line 360 of file IpIpoptApplication.hpp.

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

src/Interfaces/IpIpoptApplication.hpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IpoptApplication() [1/3]

◆ IpoptApplication() [2/3]

◆ ~IpoptApplication()

◆ IpoptApplication() [3/3]

Member Function Documentation

◆ clone()

◆ Initialize() [1/4]

◆ Initialize() [2/4]

◆ Initialize() [3/4]

◆ Initialize() [4/4]

◆ OptimizeTNLP()

◆ OptimizeNLP() [1/2]

◆ OptimizeNLP() [2/2]

◆ ReOptimizeTNLP()

◆ ReOptimizeNLP()

◆ OpenOutputFile()

◆ Jnlst()

◆ RegOptions()

◆ Options() [1/2]

◆ Options() [2/2]

◆ Statistics()

◆ IpoptNLPObject()

◆ IpoptDataObject()

◆ IpoptCQObject()

◆ AlgorithmObject()

◆ PrintCopyrightMessage()

◆ RethrowNonIpoptException()

◆ RegisterOptions()

◆ RegisterAllIpoptOptions()

◆ operator=()

◆ call_optimize()

Member Data Documentation

◆ read_params_dat_

◆ rethrow_nonipoptexception_

◆ jnlst_

◆ reg_options_

◆ options_

◆ statistics_

◆ alg_

◆ ip_nlp_

◆ ip_data_

◆ ip_cq_

◆ nlp_adapter_

◆ inexact_algorithm_

◆ replace_bounds_