Class to organize all the additional data required by the Chen-Goldfarb penalty function algorithm. More...

#include <IpInexactData.hpp>

Inheritance diagram for Ipopt::InexactData:

Public Member Functions
Constructors/Destructors
	InexactData ()
	Constructor.

	~InexactData ()
	Destructor.

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

bool	InitializeDataStructures ()
	Initialize Data Structures at the beginning.

void	AcceptTrialPoint ()
	Do whatever is necessary to accept a trial point as current iterate.

Normal step set and accessor methods
void	set_normal_x (SmartPtr< Vector > &normal_x)

void	set_normal_s (SmartPtr< Vector > &normal_s)

SmartPtr< const Vector >	normal_x ()

SmartPtr< const Vector >	normal_s ()

Tangential step set and accessor methods
void	set_tangential_x (SmartPtr< const Vector > &tangential_x)

void	set_tangential_s (SmartPtr< const Vector > &tangential_s)

SmartPtr< const Vector >	tangential_x ()

SmartPtr< const Vector >	tangential_s ()

Flag indicating if most recent step has been fully accepted.
This is used to determine if the trust region radius should be increased.
void	set_full_step_accepted (bool full_step_accepted)

bool	full_step_accepted ()

Current value of penalty parameter
void	set_curr_nu (Number nu)

Number	curr_nu ()

Current normal step computation flag
void	set_compute_normal (bool compute_normal)

bool	compute_normal ()

Next iteration normal step computation flag
void	set_next_compute_normal (bool next_compute_normal)

bool	next_compute_normal ()

Public Member Functions inherited from Ipopt::IpoptAdditionalData
	IpoptAdditionalData ()
	Default Constructor.

virtual	~IpoptAdditionalData ()
	Destructor.

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

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

void	operator= (const InexactData &)
	Overloaded Assignment Operator.

Private Attributes
bool	full_step_accepted_
	Flag indicating if most recent step has been fully accepted.

Number	curr_nu_
	current value of penalty parameter

bool	compute_normal_
	current normal step computation flag

bool	next_compute_normal_
	next iteration normal step computation flag

Normal step
SmartPtr< const Vector >	normal_x_

SmartPtr< const Vector >	normal_s_

Tangential step
SmartPtr< const Vector >	tangential_x_

SmartPtr< const Vector >	tangential_s_

Detailed Description

Class to organize all the additional data required by the Chen-Goldfarb penalty function algorithm.

Definition at line 18 of file IpInexactData.hpp.

Constructor & Destructor Documentation

◆ InexactData() [1/2]

Ipopt::InexactData::InexactData ( )

Constructor.

◆ ~InexactData()

Ipopt::InexactData::~InexactData ( )

Destructor.

◆ InexactData() [2/2]

Ipopt::InexactData::InexactData ( const InexactData & )

private

Copy Constructor.

Member Function Documentation

◆ Initialize()

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

virtual

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

The parameters are taken from the OptionsList object.

Implements Ipopt::IpoptAdditionalData.

◆ InitializeDataStructures()

bool Ipopt::InexactData::InitializeDataStructures ( )

virtual

Initialize Data Structures at the beginning.

Implements Ipopt::IpoptAdditionalData.

◆ AcceptTrialPoint()

void Ipopt::InexactData::AcceptTrialPoint ( )

virtual

Do whatever is necessary to accept a trial point as current iterate.

This is also used to finish an iteration, i.e., to release memory, and to reset any flags for a new iteration.

Implements Ipopt::IpoptAdditionalData.

◆ set_normal_x()

void Ipopt::InexactData::set_normal_x ( SmartPtr< Vector > & normal_x )

inline

Definition at line 57 of file IpInexactData.hpp.

◆ set_normal_s()

void Ipopt::InexactData::set_normal_s ( SmartPtr< Vector > & normal_s )

inline

Definition at line 65 of file IpInexactData.hpp.

◆ normal_x()

SmartPtr< const Vector > Ipopt::InexactData::normal_x ( )

inline

Definition at line 73 of file IpInexactData.hpp.

◆ normal_s()

SmartPtr< const Vector > Ipopt::InexactData::normal_s ( )

inline

Definition at line 78 of file IpInexactData.hpp.

◆ set_tangential_x()

void Ipopt::InexactData::set_tangential_x ( SmartPtr< const Vector > & tangential_x )

inline

Definition at line 86 of file IpInexactData.hpp.

◆ set_tangential_s()

void Ipopt::InexactData::set_tangential_s ( SmartPtr< const Vector > & tangential_s )

inline

Definition at line 94 of file IpInexactData.hpp.

◆ tangential_x()

SmartPtr< const Vector > Ipopt::InexactData::tangential_x ( )

inline

Definition at line 102 of file IpInexactData.hpp.

◆ tangential_s()

SmartPtr< const Vector > Ipopt::InexactData::tangential_s ( )

inline

Definition at line 107 of file IpInexactData.hpp.

◆ set_full_step_accepted()

void Ipopt::InexactData::set_full_step_accepted ( bool full_step_accepted )

inline

Definition at line 119 of file IpInexactData.hpp.

◆ full_step_accepted()

bool Ipopt::InexactData::full_step_accepted ( )

inline

Definition at line 126 of file IpInexactData.hpp.

◆ set_curr_nu()

void Ipopt::InexactData::set_curr_nu ( Number nu )

inline

Definition at line 134 of file IpInexactData.hpp.

◆ curr_nu()

Number Ipopt::InexactData::curr_nu ( )

inline

Definition at line 141 of file IpInexactData.hpp.

◆ set_compute_normal()

void Ipopt::InexactData::set_compute_normal ( bool compute_normal )

inline

Definition at line 149 of file IpInexactData.hpp.

◆ compute_normal()

bool Ipopt::InexactData::compute_normal ( )

inline

Definition at line 156 of file IpInexactData.hpp.

◆ set_next_compute_normal()

void Ipopt::InexactData::set_next_compute_normal ( bool next_compute_normal )

inline

Definition at line 164 of file IpInexactData.hpp.

◆ next_compute_normal()

bool Ipopt::InexactData::next_compute_normal ( )

inline

Definition at line 171 of file IpInexactData.hpp.

◆ operator=()

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

private

Overloaded Assignment Operator.

Member Data Documentation

◆ normal_x_

SmartPtr<const Vector> Ipopt::InexactData::normal_x_

private

Definition at line 201 of file IpInexactData.hpp.

◆ normal_s_

SmartPtr<const Vector> Ipopt::InexactData::normal_s_

private

Definition at line 202 of file IpInexactData.hpp.

◆ tangential_x_

SmartPtr<const Vector> Ipopt::InexactData::tangential_x_

private

Definition at line 207 of file IpInexactData.hpp.

◆ tangential_s_

SmartPtr<const Vector> Ipopt::InexactData::tangential_s_

private

Definition at line 208 of file IpInexactData.hpp.

◆ full_step_accepted_

bool Ipopt::InexactData::full_step_accepted_

private

Flag indicating if most recent step has been fully accepted.

Definition at line 212 of file IpInexactData.hpp.

◆ curr_nu_

Number Ipopt::InexactData::curr_nu_

private

current value of penalty parameter

Definition at line 215 of file IpInexactData.hpp.

◆ compute_normal_

bool Ipopt::InexactData::compute_normal_

private

current normal step computation flag

Definition at line 218 of file IpInexactData.hpp.

◆ next_compute_normal_

bool Ipopt::InexactData::next_compute_normal_

private

next iteration normal step computation flag

Definition at line 221 of file IpInexactData.hpp.

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

src/Algorithm/Inexact/IpInexactData.hpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InexactData() [1/2]

◆ ~InexactData()

◆ InexactData() [2/2]

Member Function Documentation

◆ Initialize()

◆ InitializeDataStructures()

◆ AcceptTrialPoint()

◆ set_normal_x()

◆ set_normal_s()

◆ normal_x()

◆ normal_s()

◆ set_tangential_x()

◆ set_tangential_s()

◆ tangential_x()

◆ tangential_s()

◆ set_full_step_accepted()

◆ full_step_accepted()

◆ set_curr_nu()

◆ curr_nu()

◆ set_compute_normal()

◆ compute_normal()

◆ set_next_compute_normal()

◆ next_compute_normal()

◆ operator=()

Member Data Documentation

◆ normal_x_

◆ normal_s_

◆ tangential_x_

◆ tangential_s_

◆ full_step_accepted_

◆ curr_nu_

◆ compute_normal_

◆ next_compute_normal_