Ipopt  3.11.9
List of all members
Ipopt::MinC_1NrmRestorationPhase Class Reference

Restoration Phase that minimizes the 1-norm of the constraint violation - using the interior point method (Ipopt). More...

#include <IpRestoMinC_1Nrm.hpp>

+ Inheritance diagram for Ipopt::MinC_1NrmRestorationPhase:

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.

 MinC_1NrmRestorationPhase ()
 Default Constructor. More...
 
 MinC_1NrmRestorationPhase (const MinC_1NrmRestorationPhase &)
 Copy Constructor. More...
 
void operator= (const MinC_1NrmRestorationPhase &)
 Overloaded Equals Operator. More...
 
Auxilliary methods
void ComputeBoundMultiplierStep (Vector &delta_z, const Vector &curr_z, const Vector &curr_slack, const Vector &trial_slack)
 Method for computing "primal-dual" step in bound multipliers, given step in slacks. More...
 

Private Attributes

Strategy objects
SmartPtr< IpoptAlgorithmresto_alg_
 
SmartPtr< EqMultiplierCalculatoreq_mult_calculator_
 
SmartPtr< OptionsListresto_options_
 Copy of original options, which is required to initialize the Ipopt algorithm strategy object before restoration phase is started. More...
 
Algorithmic parameters
Number constr_mult_reset_threshold_
 
Number bound_mult_reset_threshold_
 Maximal allowed value of a bound multiplier after restoration phase. More...
 
bool expect_infeasible_problem_
 Indicates whether problem can be expected to be infeasible. More...
 
Number constr_viol_tol_
 Constraint violation tolerance. More...
 
Number resto_failure_feasibility_threshold_
 Primal infeasibility tolerance for declaring failure of restoration phase when the non-regular termination tests are met. More...
 
Index count_restorations_
 Counter for the number of time that PerformRestoration is called. More...
 

Constructors/Destructors

 MinC_1NrmRestorationPhase (IpoptAlgorithm &resto_alg, const SmartPtr< EqMultiplierCalculator > &eq_mult_calculator)
 Constructor, taking strategy objects. More...
 
virtual ~MinC_1NrmRestorationPhase ()
 Default destructor. More...
 
virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 Overloaded from AlgorithmStrategy case class. More...
 
static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 Methods for IpoptType. More...
 
virtual bool PerformRestoration ()
 Overloaded method from RestorationPhase. More...
 

Additional Inherited Members

- Public Member Functions inherited from Ipopt::RestorationPhase
 RestorationPhase ()
 Default Constructor. More...
 
virtual ~RestorationPhase ()
 Default Destructor. More...
 
- Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
 AlgorithmStrategyObject ()
 Default Constructor. More...
 
virtual ~AlgorithmStrategyObject ()
 Default Destructor. More...
 
bool Initialize (const Journalist &jnlst, IpoptNLP &ip_nlp, IpoptData &ip_data, IpoptCalculatedQuantities &ip_cq, const OptionsList &options, const std::string &prefix)
 This method is called every time the algorithm starts again - it is used to reset any internal state. More...
 
bool ReducedInitialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
 Reduced version of the Initialize method, which does not require special Ipopt information. More...
 
- 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
 
- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Restoration Phase that minimizes the 1-norm of the constraint violation - using the interior point method (Ipopt).

Definition at line 22 of file IpRestoMinC_1Nrm.hpp.

Constructor & Destructor Documentation

◆ MinC_1NrmRestorationPhase() [1/3]

Ipopt::MinC_1NrmRestorationPhase::MinC_1NrmRestorationPhase ( IpoptAlgorithm resto_alg,
const SmartPtr< EqMultiplierCalculator > &  eq_mult_calculator 
)

Constructor, taking strategy objects.

The resto_alg strategy object is the restoration phase Ipopt algorithm. The eq_mult_calculator is used to reinitialize the equality constraint multipliers after the restoration phase algorithm has finished - unless it is NULL, in which case the multipliers are set to 0.

◆ ~MinC_1NrmRestorationPhase()

virtual Ipopt::MinC_1NrmRestorationPhase::~MinC_1NrmRestorationPhase ( )
virtual

Default destructor.

◆ MinC_1NrmRestorationPhase() [2/3]

Ipopt::MinC_1NrmRestorationPhase::MinC_1NrmRestorationPhase ( )
private

Default Constructor.

◆ MinC_1NrmRestorationPhase() [3/3]

Ipopt::MinC_1NrmRestorationPhase::MinC_1NrmRestorationPhase ( const MinC_1NrmRestorationPhase )
private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::MinC_1NrmRestorationPhase::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
)
virtual

Overloaded from AlgorithmStrategy case class.

Implements Ipopt::RestorationPhase.

◆ RegisterOptions()

static void Ipopt::MinC_1NrmRestorationPhase::RegisterOptions ( SmartPtr< RegisteredOptions roptions)
static

Methods for IpoptType.

◆ PerformRestoration()

virtual bool Ipopt::MinC_1NrmRestorationPhase::PerformRestoration ( )
protectedvirtual

Overloaded method from RestorationPhase.

Implements Ipopt::RestorationPhase.

◆ operator=()

void Ipopt::MinC_1NrmRestorationPhase::operator= ( const MinC_1NrmRestorationPhase )
private

Overloaded Equals Operator.

◆ ComputeBoundMultiplierStep()

void Ipopt::MinC_1NrmRestorationPhase::ComputeBoundMultiplierStep ( Vector delta_z,
const Vector curr_z,
const Vector curr_slack,
const Vector trial_slack 
)
private

Method for computing "primal-dual" step in bound multipliers, given step in slacks.

Member Data Documentation

◆ resto_alg_

SmartPtr<IpoptAlgorithm> Ipopt::MinC_1NrmRestorationPhase::resto_alg_
private

Definition at line 72 of file IpRestoMinC_1Nrm.hpp.

◆ eq_mult_calculator_

SmartPtr<EqMultiplierCalculator> Ipopt::MinC_1NrmRestorationPhase::eq_mult_calculator_
private

Definition at line 73 of file IpRestoMinC_1Nrm.hpp.

◆ resto_options_

SmartPtr<OptionsList> Ipopt::MinC_1NrmRestorationPhase::resto_options_
private

Copy of original options, which is required to initialize the Ipopt algorithm strategy object before restoration phase is started.

Definition at line 79 of file IpRestoMinC_1Nrm.hpp.

◆ constr_mult_reset_threshold_

Number Ipopt::MinC_1NrmRestorationPhase::constr_mult_reset_threshold_
private

Definition at line 83 of file IpRestoMinC_1Nrm.hpp.

◆ bound_mult_reset_threshold_

Number Ipopt::MinC_1NrmRestorationPhase::bound_mult_reset_threshold_
private

Maximal allowed value of a bound multiplier after restoration phase.

Definition at line 87 of file IpRestoMinC_1Nrm.hpp.

◆ expect_infeasible_problem_

bool Ipopt::MinC_1NrmRestorationPhase::expect_infeasible_problem_
private

Indicates whether problem can be expected to be infeasible.

This will request the to set kappa_resto to a small value for the first time the restoration phase is called. (ToDo)

Definition at line 91 of file IpRestoMinC_1Nrm.hpp.

◆ constr_viol_tol_

Number Ipopt::MinC_1NrmRestorationPhase::constr_viol_tol_
private

Constraint violation tolerance.

Definition at line 93 of file IpRestoMinC_1Nrm.hpp.

◆ resto_failure_feasibility_threshold_

Number Ipopt::MinC_1NrmRestorationPhase::resto_failure_feasibility_threshold_
private

Primal infeasibility tolerance for declaring failure of restoration phase when the non-regular termination tests are met.

Definition at line 97 of file IpRestoMinC_1Nrm.hpp.

◆ count_restorations_

Index Ipopt::MinC_1NrmRestorationPhase::count_restorations_
private

Counter for the number of time that PerformRestoration is called.

Definition at line 102 of file IpRestoMinC_1Nrm.hpp.


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