Class to organize all the data required by the algorithm. More...

#include <IpIpoptData.hpp>

Inheritance diagram for Ipopt::IpoptData:

Public Member Functions
bool	InitializeDataStructures (IpoptNLP &ip_nlp, bool want_x, bool want_y_c, bool want_y_d, bool want_z_L, bool want_z_U)
	Initialize Data Structures.

bool	Initialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
	This method must be called to initialize the global algorithmic parameters.

IPOPT_DEPRECATED Number	cpu_time_start () const
	Cpu time counter at the beginning of the optimization.

TimingStatistics &	TimingStats ()
	Return Timing Statistics Object.

const TimingStatistics &	TimingStats () const
	Return Timing Statistics Object.

bool	HaveAddData ()
	Check if additional data has been set.

IpoptAdditionalData &	AdditionalData ()
	Get access to additional data object.

void	SetAddData (SmartPtr< IpoptAdditionalData > add_data)
	Set a new pointer for additional Ipopt data.

void	setPDPert (Number pd_pert_x, Number pd_pert_s, Number pd_pert_c, Number pd_pert_d)
	Set the perturbation of the primal-dual system.

void	getPDPert (Number &pd_pert_x, Number &pd_pert_s, Number &pd_pert_c, Number &pd_pert_d)
	Get the current perturbation of the primal-dual system.

Constructors/Destructors
	IpoptData (SmartPtr< IpoptAdditionalData > add_data=NULL)
	Constructor.

virtual	~IpoptData ()
	Destructor.

Get Methods for Iterates
SmartPtr< const IteratesVector >	curr () const
	Current point.

SmartPtr< const IteratesVector >	trial () const
	Get the current point in a copied container that is non-const.

void	set_trial (SmartPtr< IteratesVector > &trial)
	Get Trial point in a copied container that is non-const.

void	SetTrialPrimalVariablesFromStep (Number alpha, const Vector &delta_x, const Vector &delta_s)
	Set the values of the primal trial variables (x and s) from provided Step with step length alpha.

void	SetTrialEqMultipliersFromStep (Number alpha, const Vector &delta_y_c, const Vector &delta_y_d)
	Set the values of the trial values for the equality constraint multipliers (y_c and y_d) from provided step with step length alpha.

void	SetTrialBoundMultipliersFromStep (Number alpha, const Vector &delta_z_L, const Vector &delta_z_U, const Vector &delta_v_L, const Vector &delta_v_U)
	Set the value of the trial values for the bound multipliers (z_L, z_U, v_L, v_U) from provided step with step length alpha.

SmartPtr< const IteratesVector >	delta () const
	get the current delta

void	set_delta (SmartPtr< IteratesVector > &delta)
	Set the current delta.

void	set_delta (SmartPtr< const IteratesVector > &delta)
	Set the current delta.

SmartPtr< const IteratesVector >	delta_aff () const
	Affine Delta.

void	set_delta_aff (SmartPtr< IteratesVector > &delta_aff)
	Set the affine delta.

SmartPtr< const SymMatrix >	W ()
	Hessian or Hessian approximation (do not hold on to it, it might be changed)

void	Set_W (SmartPtr< const SymMatrix > W)
	Set Hessian approximation.

("Main") Primal-dual search direction.
Those fields are used to store the search directions computed from solving the primal-dual system, and can be used in the line search. They are overwritten in every iteration, so do not hold on to the pointers (make copies instead)
bool	HaveDeltas () const
	Returns true, if the primal-dual step have been already computed for the current iteration.

void	SetHaveDeltas (bool have_deltas)
	Method for setting the HaveDeltas flag.

Public Methods for updating iterates
void	CopyTrialToCurrent ()
	Copy the trial values to the current values.

void	AcceptTrialPoint ()
	Set the current iterate values from the trial values.

General algorithmic data
Index	iter_count () const

void	Set_iter_count (Index iter_count)

Number	curr_mu () const

void	Set_mu (Number mu)

bool	MuInitialized () const

Number	curr_tau () const

void	Set_tau (Number tau)

bool	TauInitialized () const

void	SetFreeMuMode (bool free_mu_mode)

bool	FreeMuMode () const

void	Set_tiny_step_flag (bool flag)
	Setting the flag that indicates if a tiny step (below machine precision) has been detected.

bool	tiny_step_flag ()


Number	tol () const
	Overall convergence tolerance.

void	Set_tol (Number tol)
	Set a new value for the tolerance.

Information gathered for iteration output
Number	info_regu_x () const

void	Set_info_regu_x (Number regu_x)

Number	info_alpha_primal () const

void	Set_info_alpha_primal (Number alpha_primal)

char	info_alpha_primal_char () const

void	Set_info_alpha_primal_char (char info_alpha_primal_char)

Number	info_alpha_dual () const

void	Set_info_alpha_dual (Number alpha_dual)

Index	info_ls_count () const

void	Set_info_ls_count (Index ls_count)

bool	info_skip_output () const

void	Append_info_string (const std::string &add_str)

const std::string &	info_string () const

void	Set_info_skip_output (bool info_skip_output)
	Set this to true, if the next time when output is written, the summary line should not be printed.

Number	info_last_output ()
	gives time when the last summary output line was printed

void	Set_info_last_output (Number info_last_output)
	sets time when the last summary output line was printed

int	info_iters_since_header ()
	gives number of iteration summaries actually printed since last summary header was printed

void	Inc_info_iters_since_header ()
	increases number of iteration summaries actually printed since last summary header was printed

void	Set_info_iters_since_header (int info_iters_since_header)
	sets number of iteration summaries actually printed since last summary header was printed

void	ResetInfo ()
	Reset all info fields.

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 (const SmartPtr< RegisteredOptions > &roptions)

Private Member Functions
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.
	IpoptData (const IpoptData &)
	Copy Constructor.

void	operator= (const IpoptData &)
	Default Assignment Operator.

Private Attributes
Index	iter_count_
	iteration count

Number	curr_mu_
	current barrier parameter

bool	mu_initialized_

Number	curr_tau_
	current fraction to the boundary parameter

bool	tau_initialized_

bool	initialize_called_
	flag indicating if Initialize method has been called (for debugging)

bool	have_prototypes_
	flag for debugging whether we have already curr_ values available (from which new Vectors can be generated

SmartPtr< IteratesVectorSpace >	iterates_space_
	VectorSpace for all the iterates.

TimingStatistics	timing_statistics_
	TimingStatistics object collecting all Ipopt timing statistics.

SmartPtr< IpoptAdditionalData >	add_data_
	Object for the data specific for the Chen-Goldfarb penalty method algorithm.

Iterates
SmartPtr< const IteratesVector >	curr_
	Main iteration variables (current iteration)

SmartPtr< const IteratesVector >	trial_
	Main iteration variables (trial calculations)

SmartPtr< const SymMatrix >	W_
	Hessian (approximation) - might be changed elsewhere!

Primal-dual Step
SmartPtr< const IteratesVector >	delta_

bool	have_deltas_
	The following flag is set to true, if some other part of the algorithm (like the method for computing the barrier parameter) has already computed the primal-dual search direction.

Global algorithm parameters.
Those are options that can be modified by the user and appear at different places in the algorithm. They are set using an OptionsList object in the Initialize method.
Number	tol_
	Overall convergence tolerance.

Status data
bool	free_mu_mode_
	flag indicating whether the algorithm is in the free mu mode

bool	tiny_step_flag_
	flag indicating if a tiny step has been detected

Gathered information for iteration output
Number	info_regu_x_
	Size of regularization for the Hessian.

Number	info_alpha_primal_
	Primal step size.

char	info_alpha_primal_char_
	Info character for primal step size.

Number	info_alpha_dual_
	Dual step size.

Index	info_ls_count_
	Number of backtracking trial steps.

bool	info_skip_output_
	true, if next summary output line should not be printed (eg after restoration phase).

std::string	info_string_
	any string of characters for the end of the output line

Number	info_last_output_
	time when the last summary output line was printed

int	info_iters_since_header_
	number of iteration summaries actually printed since last summary header was printed

Information about the perturbation of the primal-dual system
Number	pd_pert_x_

Number	pd_pert_s_

Number	pd_pert_c_

Number	pd_pert_d_

Affine-scaling step.
This used to transfer the information about the affine-scaling step from the computation of the barrier parameter to the corrector (in the line search).
SmartPtr< const IteratesVector >	delta_aff_

bool	have_affine_deltas_
	The following flag is set to true, if some other part of the algorithm (like the method for computing the barrier parameter) has already computed the affine-scaling step.

bool	HaveAffineDeltas () const
	Returns true, if the affine-scaling step have been already computed for the current iteration.

void	SetHaveAffineDeltas (bool have_affine_deltas)
	Method for setting the HaveDeltas flag.

Detailed Description

Class to organize all the data required by the algorithm.

Internally, once this Data object has been initialized, all internal curr_ vectors must always be set (so that prototypes are available). The current values can only be set from the trial values. The trial values can be set by copying from a vector or by adding some fraction of a step to the current values. This object also stores steps, which allows to easily communicate the step from the step computation object to the line search object.

Definition at line 97 of file IpIpoptData.hpp.

Constructor & Destructor Documentation

◆ IpoptData() [1/2]

Ipopt::IpoptData::IpoptData ( SmartPtr< IpoptAdditionalData > add_data = NULL )

Constructor.

◆ ~IpoptData()

virtual Ipopt::IpoptData::~IpoptData ( )

virtual

Destructor.

◆ IpoptData() [2/2]

Ipopt::IpoptData::IpoptData ( const IpoptData & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeDataStructures()

bool Ipopt::IpoptData::InitializeDataStructures	(	IpoptNLP &	ip_nlp,
		bool	want_x,
		bool	want_y_c,
		bool	want_y_d,
		bool	want_z_L,
		bool	want_z_U
	)

Initialize Data Structures.

◆ Initialize()

bool Ipopt::IpoptData::Initialize	(	const Journalist &	jnlst,
		const OptionsList &	options,
		const std::string &	prefix
	)

This method must be called to initialize the global algorithmic parameters.

The parameters are taken from the OptionsList object.

◆ curr()

SmartPtr< const IteratesVector > Ipopt::IpoptData::curr ( ) const

inline

Current point.

Definition at line 822 of file IpIpoptData.hpp.

◆ trial()

SmartPtr< const IteratesVector > Ipopt::IpoptData::trial ( ) const

inline

Get the current point in a copied container that is non-const.

The entries in the container cannot be modified, but the container can be modified to point to new entries. Get Trial point

Definition at line 829 of file IpIpoptData.hpp.

◆ set_trial()

void Ipopt::IpoptData::set_trial ( SmartPtr< IteratesVector > & trial )

inline

Get Trial point in a copied container that is non-const.

The entries in the container can not be modified, but the container can be modified to point to new entries. Set the trial point.

This method copies the pointer for efficiency (no copy and to keep cache tags the same) so after you call set you cannot modify the data again.

Definition at line 871 of file IpIpoptData.hpp.

◆ SetTrialPrimalVariablesFromStep()

void Ipopt::IpoptData::SetTrialPrimalVariablesFromStep	(	Number	alpha,
		const Vector &	delta_x,
		const Vector &	delta_s
	)

Set the values of the primal trial variables (x and s) from provided Step with step length alpha.

◆ SetTrialEqMultipliersFromStep()

void Ipopt::IpoptData::SetTrialEqMultipliersFromStep	(	Number	alpha,
		const Vector &	delta_y_c,
		const Vector &	delta_y_d
	)

Set the values of the trial values for the equality constraint multipliers (y_c and y_d) from provided step with step length alpha.

◆ SetTrialBoundMultipliersFromStep()

void Ipopt::IpoptData::SetTrialBoundMultipliersFromStep	(	Number	alpha,
		const Vector &	delta_z_L,
		const Vector &	delta_z_U,
		const Vector &	delta_v_L,
		const Vector &	delta_v_U
	)

Set the value of the trial values for the bound multipliers (z_L, z_U, v_L, v_U) from provided step with step length alpha.

◆ delta()

SmartPtr< const IteratesVector > Ipopt::IpoptData::delta ( ) const

inline

get the current delta

Definition at line 836 of file IpIpoptData.hpp.

◆ set_delta() [1/2]

void Ipopt::IpoptData::set_delta ( SmartPtr< IteratesVector > & delta )

inline

Set the current delta.

Like the trial point, this method copies the pointer for efficiency (no copy and to keep cache tags the same) so after you call set, you cannot modify the data

Definition at line 896 of file IpIpoptData.hpp.

◆ set_delta() [2/2]

void Ipopt::IpoptData::set_delta ( SmartPtr< const IteratesVector > & delta )

inline

Set the current delta.

Like the trial point, this method copies the pointer for efficiency (no copy and to keep cache tags the same) so after you call set, you cannot modify the data. This is the version that is happy with a pointer to const IteratesVector.

Definition at line 919 of file IpIpoptData.hpp.

◆ delta_aff()

SmartPtr< const IteratesVector > Ipopt::IpoptData::delta_aff ( ) const

inline

Affine Delta.

Definition at line 843 of file IpIpoptData.hpp.

◆ set_delta_aff()

void Ipopt::IpoptData::set_delta_aff ( SmartPtr< IteratesVector > & delta_aff )

inline

Set the affine delta.

Like the trial point, this method copies the pointer for efficiency (no copy and to keep cache tags the same) so after you call set, you cannot modify the data

Definition at line 942 of file IpIpoptData.hpp.

◆ W()

SmartPtr< const SymMatrix > Ipopt::IpoptData::W ( )

inline

Hessian or Hessian approximation (do not hold on to it, it might be changed)

Definition at line 239 of file IpIpoptData.hpp.

◆ Set_W()

void Ipopt::IpoptData::Set_W ( SmartPtr< const SymMatrix > W )

inline

Set Hessian approximation.

Definition at line 245 of file IpIpoptData.hpp.

◆ HaveDeltas()

bool Ipopt::IpoptData::HaveDeltas ( ) const

inline

Returns true, if the primal-dual step have been already computed for the current iteration.

This flag is reset after every call of AcceptTrialPoint(). If the search direction is computed during the computation of the barrier parameter, the method computing the barrier parameter should call SetHaveDeltas(true) to tell the IpoptAlgorithm object that it doesn't need to recompute the primal-dual step.

Definition at line 271 of file IpIpoptData.hpp.

◆ SetHaveDeltas()

void Ipopt::IpoptData::SetHaveDeltas ( bool have_deltas )

inline

Method for setting the HaveDeltas flag.

This method should be called if some method computes the primal-dual step (and stores it in the delta_ fields of IpoptData) at an early part of the iteration. If that flag is set to true, the IpoptAlgorithm object will not recompute the step.

Definition at line 284 of file IpIpoptData.hpp.

◆ HaveAffineDeltas()

bool Ipopt::IpoptData::HaveAffineDeltas ( ) const

inline

Returns true, if the affine-scaling step have been already computed for the current iteration.

This flag is reset after every call of AcceptTrialPoint(). If the search direction is computed during the computation of the barrier parameter, the method computing the barrier parameter should call SetHaveDeltas(true) to tell the line search does not have to recompute them in case it wants to do a corrector step.

Definition at line 311 of file IpIpoptData.hpp.

◆ SetHaveAffineDeltas()

void Ipopt::IpoptData::SetHaveAffineDeltas ( bool have_affine_deltas )

inline

Method for setting the HaveDeltas flag.

This method should be called if some method computes the primal-dual step (and stores it in the delta_ fields of IpoptData) at an early part of the iteration. If that flag is set to true, the IpoptAlgorithm object will not recompute the step.

Definition at line 324 of file IpIpoptData.hpp.

◆ CopyTrialToCurrent()

void Ipopt::IpoptData::CopyTrialToCurrent ( )

inline

Copy the trial values to the current values.

Definition at line 851 of file IpIpoptData.hpp.

◆ AcceptTrialPoint()

void Ipopt::IpoptData::AcceptTrialPoint ( )

Set the current iterate values from the trial values.

◆ iter_count()

Index Ipopt::IpoptData::iter_count ( ) const

inline

Definition at line 344 of file IpIpoptData.hpp.

◆ Set_iter_count()

void Ipopt::IpoptData::Set_iter_count ( Index iter_count )

inline

Definition at line 348 of file IpIpoptData.hpp.

◆ curr_mu()

Number Ipopt::IpoptData::curr_mu ( ) const

inline

Definition at line 355 of file IpIpoptData.hpp.

◆ Set_mu()

void Ipopt::IpoptData::Set_mu ( Number mu )

inline

Definition at line 360 of file IpIpoptData.hpp.

◆ MuInitialized()

bool Ipopt::IpoptData::MuInitialized ( ) const

inline

Definition at line 367 of file IpIpoptData.hpp.

◆ curr_tau()

Number Ipopt::IpoptData::curr_tau ( ) const

inline

Definition at line 372 of file IpIpoptData.hpp.

◆ Set_tau()

void Ipopt::IpoptData::Set_tau ( Number tau )

inline

Definition at line 377 of file IpIpoptData.hpp.

◆ TauInitialized()

bool Ipopt::IpoptData::TauInitialized ( ) const

inline

Definition at line 384 of file IpIpoptData.hpp.

◆ SetFreeMuMode()

void Ipopt::IpoptData::SetFreeMuMode ( bool free_mu_mode )

inline

Definition at line 389 of file IpIpoptData.hpp.

◆ FreeMuMode()

bool Ipopt::IpoptData::FreeMuMode ( ) const

inline

Definition at line 395 of file IpIpoptData.hpp.

◆ Set_tiny_step_flag()

void Ipopt::IpoptData::Set_tiny_step_flag ( bool flag )

inline

Setting the flag that indicates if a tiny step (below machine precision) has been detected.

Definition at line 403 of file IpIpoptData.hpp.

◆ tiny_step_flag()

bool Ipopt::IpoptData::tiny_step_flag ( )

inline

Definition at line 409 of file IpIpoptData.hpp.

◆ tol()

Number Ipopt::IpoptData::tol ( ) const

inline

Overall convergence tolerance.

It is used in the convergence test, but also in some other parts of the algorithm that depend on the specified tolerance, such as the minimum value for the barrier parameter. Obtain the tolerance.

Definition at line 424 of file IpIpoptData.hpp.

◆ Set_tol()

void Ipopt::IpoptData::Set_tol ( Number tol )

inline

Set a new value for the tolerance.

One should be very careful when using this, since changing the predefined tolerance might have unexpected consequences. This method is for example used in the restoration convergence checker to tighten the restoration phase convergence tolerance, if the restoration phase converged to a point that has not a large value for the constraint violation.

Definition at line 439 of file IpIpoptData.hpp.

◆ cpu_time_start()

IPOPT_DEPRECATED Number Ipopt::IpoptData::cpu_time_start ( ) const

inline

Cpu time counter at the beginning of the optimization.

This is useful to see how much CPU time has been spent in this optimization run.

Can only be called after beginning of optimization.

Definition at line 455 of file IpIpoptData.hpp.

◆ info_regu_x()

Number Ipopt::IpoptData::info_regu_x ( ) const

inline

Definition at line 462 of file IpIpoptData.hpp.

◆ Set_info_regu_x()

void Ipopt::IpoptData::Set_info_regu_x ( Number regu_x )

inline

Definition at line 466 of file IpIpoptData.hpp.

◆ info_alpha_primal()

Number Ipopt::IpoptData::info_alpha_primal ( ) const

inline

Definition at line 472 of file IpIpoptData.hpp.

◆ Set_info_alpha_primal()

void Ipopt::IpoptData::Set_info_alpha_primal ( Number alpha_primal )

inline

Definition at line 476 of file IpIpoptData.hpp.

◆ info_alpha_primal_char()

char Ipopt::IpoptData::info_alpha_primal_char ( ) const

inline

Definition at line 482 of file IpIpoptData.hpp.

◆ Set_info_alpha_primal_char()

void Ipopt::IpoptData::Set_info_alpha_primal_char ( char info_alpha_primal_char )

inline

Definition at line 486 of file IpIpoptData.hpp.

◆ info_alpha_dual()

Number Ipopt::IpoptData::info_alpha_dual ( ) const

inline

Definition at line 492 of file IpIpoptData.hpp.

◆ Set_info_alpha_dual()

void Ipopt::IpoptData::Set_info_alpha_dual ( Number alpha_dual )

inline

Definition at line 496 of file IpIpoptData.hpp.

◆ info_ls_count()

Index Ipopt::IpoptData::info_ls_count ( ) const

inline

Definition at line 502 of file IpIpoptData.hpp.

◆ Set_info_ls_count()

void Ipopt::IpoptData::Set_info_ls_count ( Index ls_count )

inline

Definition at line 506 of file IpIpoptData.hpp.

◆ info_skip_output()

bool Ipopt::IpoptData::info_skip_output ( ) const

inline

Definition at line 512 of file IpIpoptData.hpp.

◆ Append_info_string()

void Ipopt::IpoptData::Append_info_string ( const std::string & add_str )

inline

Definition at line 516 of file IpIpoptData.hpp.

◆ info_string()

const std::string & Ipopt::IpoptData::info_string ( ) const

inline

Definition at line 522 of file IpIpoptData.hpp.

◆ Set_info_skip_output()

void Ipopt::IpoptData::Set_info_skip_output ( bool info_skip_output )

inline

Set this to true, if the next time when output is written, the summary line should not be printed.

Definition at line 529 of file IpIpoptData.hpp.

◆ info_last_output()

Number Ipopt::IpoptData::info_last_output ( )

inline

gives time when the last summary output line was printed

Definition at line 537 of file IpIpoptData.hpp.

◆ Set_info_last_output()

void Ipopt::IpoptData::Set_info_last_output ( Number info_last_output )

inline

sets time when the last summary output line was printed

Definition at line 542 of file IpIpoptData.hpp.

◆ info_iters_since_header()

int Ipopt::IpoptData::info_iters_since_header ( )

inline

gives number of iteration summaries actually printed since last summary header was printed

Definition at line 552 of file IpIpoptData.hpp.

◆ Inc_info_iters_since_header()

void Ipopt::IpoptData::Inc_info_iters_since_header ( )

inline

increases number of iteration summaries actually printed since last summary header was printed

Definition at line 559 of file IpIpoptData.hpp.

◆ Set_info_iters_since_header()

void Ipopt::IpoptData::Set_info_iters_since_header ( int info_iters_since_header )

inline

sets number of iteration summaries actually printed since last summary header was printed

Definition at line 566 of file IpIpoptData.hpp.

◆ ResetInfo()

void Ipopt::IpoptData::ResetInfo ( )

inline

Reset all info fields.

Definition at line 574 of file IpIpoptData.hpp.

◆ TimingStats() [1/2]

TimingStatistics & Ipopt::IpoptData::TimingStats ( )

inline

Return Timing Statistics Object.

Definition at line 586 of file IpIpoptData.hpp.

◆ TimingStats() [2/2]

const TimingStatistics & Ipopt::IpoptData::TimingStats ( ) const

inline

Return Timing Statistics Object.

Since: 3.14.11

Definition at line 595 of file IpIpoptData.hpp.

◆ HaveAddData()

bool Ipopt::IpoptData::HaveAddData ( )

inline

Check if additional data has been set.

Definition at line 601 of file IpIpoptData.hpp.

◆ AdditionalData()

IpoptAdditionalData & Ipopt::IpoptData::AdditionalData ( )

inline

Get access to additional data object.

Definition at line 607 of file IpIpoptData.hpp.

◆ SetAddData()

void Ipopt::IpoptData::SetAddData ( SmartPtr< IpoptAdditionalData > add_data )

inline

Set a new pointer for additional Ipopt data.

Definition at line 613 of file IpIpoptData.hpp.

◆ setPDPert()

void Ipopt::IpoptData::setPDPert	(	Number	pd_pert_x,
		Number	pd_pert_s,
		Number	pd_pert_c,
		Number	pd_pert_d
	)

inline

Set the perturbation of the primal-dual system.

Definition at line 623 of file IpIpoptData.hpp.

◆ getPDPert()

void Ipopt::IpoptData::getPDPert	(	Number &	pd_pert_x,
		Number &	pd_pert_s,
		Number &	pd_pert_c,
		Number &	pd_pert_d
	)

inline

Get the current perturbation of the primal-dual system.

Definition at line 637 of file IpIpoptData.hpp.

◆ RegisterOptions()

static void Ipopt::IpoptData::RegisterOptions ( const SmartPtr< RegisteredOptions > & roptions )

static

◆ operator=()

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

private

Default Assignment Operator.

Member Data Documentation

◆ curr_

SmartPtr<const IteratesVector> Ipopt::IpoptData::curr_

private

Main iteration variables (current iteration)

Definition at line 658 of file IpIpoptData.hpp.

◆ trial_

SmartPtr<const IteratesVector> Ipopt::IpoptData::trial_

private

Main iteration variables (trial calculations)

Definition at line 661 of file IpIpoptData.hpp.

◆ W_

SmartPtr<const SymMatrix> Ipopt::IpoptData::W_

private

Hessian (approximation) - might be changed elsewhere!

Definition at line 664 of file IpIpoptData.hpp.

◆ delta_

SmartPtr<const IteratesVector> Ipopt::IpoptData::delta_

private

Definition at line 668 of file IpIpoptData.hpp.

◆ have_deltas_

bool Ipopt::IpoptData::have_deltas_

private

The following flag is set to true, if some other part of the algorithm (like the method for computing the barrier parameter) has already computed the primal-dual search direction.

This flag is reset when the AcceptTrialPoint method is called.

Definition at line 677 of file IpIpoptData.hpp.

◆ delta_aff_

SmartPtr<const IteratesVector> Ipopt::IpoptData::delta_aff_

private

Definition at line 688 of file IpIpoptData.hpp.

◆ have_affine_deltas_

bool Ipopt::IpoptData::have_affine_deltas_

private

The following flag is set to true, if some other part of the algorithm (like the method for computing the barrier parameter) has already computed the affine-scaling step.

This flag is reset when the AcceptTrialPoint method is called.

Definition at line 696 of file IpIpoptData.hpp.

◆ iter_count_

Index Ipopt::IpoptData::iter_count_

private

iteration count

Definition at line 700 of file IpIpoptData.hpp.

◆ curr_mu_

Number Ipopt::IpoptData::curr_mu_

private

current barrier parameter

Definition at line 703 of file IpIpoptData.hpp.

◆ mu_initialized_

bool Ipopt::IpoptData::mu_initialized_

private

Definition at line 704 of file IpIpoptData.hpp.

◆ curr_tau_

Number Ipopt::IpoptData::curr_tau_

private

current fraction to the boundary parameter

Definition at line 707 of file IpIpoptData.hpp.

◆ tau_initialized_

bool Ipopt::IpoptData::tau_initialized_

private

Definition at line 708 of file IpIpoptData.hpp.

◆ initialize_called_

bool Ipopt::IpoptData::initialize_called_

private

flag indicating if Initialize method has been called (for debugging)

Definition at line 711 of file IpIpoptData.hpp.

◆ have_prototypes_

bool Ipopt::IpoptData::have_prototypes_

private

flag for debugging whether we have already curr_ values available (from which new Vectors can be generated

Definition at line 716 of file IpIpoptData.hpp.

◆ tol_

Number Ipopt::IpoptData::tol_

private

Overall convergence tolerance.

Definition at line 727 of file IpIpoptData.hpp.

◆ free_mu_mode_

bool Ipopt::IpoptData::free_mu_mode_

private

flag indicating whether the algorithm is in the free mu mode

Definition at line 733 of file IpIpoptData.hpp.

◆ tiny_step_flag_

bool Ipopt::IpoptData::tiny_step_flag_

private

flag indicating if a tiny step has been detected

Definition at line 735 of file IpIpoptData.hpp.

◆ info_regu_x_

Number Ipopt::IpoptData::info_regu_x_

private

Size of regularization for the Hessian.

Definition at line 741 of file IpIpoptData.hpp.

◆ info_alpha_primal_

Number Ipopt::IpoptData::info_alpha_primal_

private

Primal step size.

Definition at line 743 of file IpIpoptData.hpp.

◆ info_alpha_primal_char_

char Ipopt::IpoptData::info_alpha_primal_char_

private

Info character for primal step size.

Definition at line 745 of file IpIpoptData.hpp.

◆ info_alpha_dual_

Number Ipopt::IpoptData::info_alpha_dual_

private

Dual step size.

Definition at line 747 of file IpIpoptData.hpp.

◆ info_ls_count_

Index Ipopt::IpoptData::info_ls_count_

private

Number of backtracking trial steps.

Definition at line 749 of file IpIpoptData.hpp.

◆ info_skip_output_

bool Ipopt::IpoptData::info_skip_output_

private

true, if next summary output line should not be printed (eg after restoration phase).

Definition at line 753 of file IpIpoptData.hpp.

◆ info_string_

std::string Ipopt::IpoptData::info_string_

private

any string of characters for the end of the output line

Definition at line 755 of file IpIpoptData.hpp.

◆ info_last_output_

Number Ipopt::IpoptData::info_last_output_

private

time when the last summary output line was printed

Definition at line 757 of file IpIpoptData.hpp.

◆ info_iters_since_header_

int Ipopt::IpoptData::info_iters_since_header_

private

number of iteration summaries actually printed since last summary header was printed

Definition at line 761 of file IpIpoptData.hpp.

◆ iterates_space_

SmartPtr<IteratesVectorSpace> Ipopt::IpoptData::iterates_space_

private

VectorSpace for all the iterates.

Definition at line 765 of file IpIpoptData.hpp.

◆ timing_statistics_

TimingStatistics Ipopt::IpoptData::timing_statistics_

private

TimingStatistics object collecting all Ipopt timing statistics.

Definition at line 768 of file IpIpoptData.hpp.

◆ add_data_

SmartPtr<IpoptAdditionalData> Ipopt::IpoptData::add_data_

private

Object for the data specific for the Chen-Goldfarb penalty method algorithm.

Definition at line 773 of file IpIpoptData.hpp.

◆ pd_pert_x_

Number Ipopt::IpoptData::pd_pert_x_

private

Definition at line 777 of file IpIpoptData.hpp.

◆ pd_pert_s_

Number Ipopt::IpoptData::pd_pert_s_

private

Definition at line 778 of file IpIpoptData.hpp.

◆ pd_pert_c_

Number Ipopt::IpoptData::pd_pert_c_

private

Definition at line 779 of file IpIpoptData.hpp.

◆ pd_pert_d_

Number Ipopt::IpoptData::pd_pert_d_

private

Definition at line 780 of file IpIpoptData.hpp.

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

src/Algorithm/IpIpoptData.hpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Affine-scaling step.

Detailed Description

Constructor & Destructor Documentation

◆ IpoptData() [1/2]

◆ ~IpoptData()

◆ IpoptData() [2/2]

Member Function Documentation

◆ InitializeDataStructures()

◆ Initialize()

◆ curr()

◆ trial()

◆ set_trial()

◆ SetTrialPrimalVariablesFromStep()

◆ SetTrialEqMultipliersFromStep()

◆ SetTrialBoundMultipliersFromStep()

◆ delta()

◆ set_delta() [1/2]

◆ set_delta() [2/2]

◆ delta_aff()

◆ set_delta_aff()

◆ W()

◆ Set_W()

◆ HaveDeltas()

◆ SetHaveDeltas()

◆ HaveAffineDeltas()

◆ SetHaveAffineDeltas()

◆ CopyTrialToCurrent()

◆ AcceptTrialPoint()

◆ iter_count()

◆ Set_iter_count()

◆ curr_mu()

◆ Set_mu()

◆ MuInitialized()

◆ curr_tau()

◆ Set_tau()

◆ TauInitialized()

◆ SetFreeMuMode()

◆ FreeMuMode()

◆ Set_tiny_step_flag()

◆ tiny_step_flag()

◆ tol()

◆ Set_tol()

◆ cpu_time_start()

◆ info_regu_x()

◆ Set_info_regu_x()

◆ info_alpha_primal()

◆ Set_info_alpha_primal()

◆ info_alpha_primal_char()

◆ Set_info_alpha_primal_char()

◆ info_alpha_dual()

◆ Set_info_alpha_dual()

◆ info_ls_count()

◆ Set_info_ls_count()

◆ info_skip_output()

◆ Append_info_string()

◆ info_string()

◆ Set_info_skip_output()

◆ info_last_output()

◆ Set_info_last_output()

◆ info_iters_since_header()

◆ Inc_info_iters_since_header()

◆ Set_info_iters_since_header()

◆ ResetInfo()

◆ TimingStats() [1/2]

◆ TimingStats() [2/2]

◆ HaveAddData()

◆ AdditionalData()

◆ SetAddData()

◆ setPDPert()

◆ getPDPert()

◆ RegisterOptions()

◆ operator=()

Member Data Documentation

◆ curr_

◆ trial_

◆ W_