|
Ipopt Documentation
|
|
|
Ipopt Documentation
|
|
Class implementing an initialization procedure for warm starts. More...
#include <IpWarmStartIterateInitializer.hpp>
Inheritance diagram for Ipopt::WarmStartIterateInitializer:Public Member Functions | |
| virtual bool | InitializeImpl (const OptionsList &options, const std::string &prefix) |
| Implementation of the initialization method that has to be overloaded by for each derived class. | |
| virtual bool | SetInitialIterates () |
| Compute the initial iterates and set the into the curr field of the ip_data object. | |
Constructors/Destructors | |
| WarmStartIterateInitializer () | |
| Constructor. | |
| virtual | ~WarmStartIterateInitializer () |
| Destructor. | |
| Public Member Functions inherited from Ipopt::IterateInitializer | |
| IterateInitializer () | |
| Default Constructor. | |
| virtual | ~IterateInitializer () |
| Default destructor. | |
| Public Member Functions inherited from Ipopt::AlgorithmStrategyObject | |
| 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. | |
| 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. | |
| AlgorithmStrategyObject () | |
| Default Constructor. | |
| virtual | ~AlgorithmStrategyObject () |
| 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 |
Static Public Member Functions | |
| static void | RegisterOptions (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. | |
| WarmStartIterateInitializer (const WarmStartIterateInitializer &) | |
| Copy Constructor. | |
| void | operator= (const WarmStartIterateInitializer &) |
| Default Assignment Operator. | |
Auxiliary functions | |
| void | process_target_mu (Number factor, const Vector &curr_vars, const Vector &curr_slacks, const Vector &curr_mults, const Matrix &P, SmartPtr< const Vector > &ret_vars, SmartPtr< const Vector > &ret_mults) |
| void | adapt_to_target_mu (Vector &new_s, Vector &new_z, Number target_mu) |
Private Attributes | |
Algorithmic Parameters | |
| Number | warm_start_bound_push_ |
| Absolute parameters for bumping x0 in warm start mode. | |
| Number | warm_start_bound_frac_ |
| Relative parameters for bumping x0 in warm start mode. | |
| Number | warm_start_slack_bound_push_ |
| Absolute parameters for bumping s0 in warm start mode. | |
| Number | warm_start_slack_bound_frac_ |
| Relative parameters for bumping s0 in warm start mode. | |
| Number | warm_start_mult_bound_push_ |
| Parameters for bumping initial bound multipliers. | |
| Number | warm_start_mult_init_max_ |
| Maximal size of entries in bound and equality constraint multipliers in magnitude. | |
| Number | warm_start_target_mu_ |
| Target values for the barrier parameter in warm start option. | |
| bool | warm_start_entire_iterate_ |
| Indicator for which method in the NLP should be used to get the warm start. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject | |
| const Journalist & | Jnlst () const |
| IpoptNLP & | IpNLP () const |
| IpoptData & | IpData () const |
| IpoptCalculatedQuantities & | IpCq () const |
| bool | HaveIpData () const |
Class implementing an initialization procedure for warm starts.
Definition at line 17 of file IpWarmStartIterateInitializer.hpp.
| Ipopt::WarmStartIterateInitializer::WarmStartIterateInitializer | ( | ) |
Constructor.
|
inlinevirtual |
Destructor.
Definition at line 26 of file IpWarmStartIterateInitializer.hpp.
|
private |
Copy Constructor.
|
virtual |
Implementation of the initialization method that has to be overloaded by for each derived class.
Implements Ipopt::IterateInitializer.
Compute the initial iterates and set the into the curr field of the ip_data object.
Implements Ipopt::IterateInitializer.
|
static |
|
private |
Default Assignment Operator.
|
private |
|
private |
|
private |
Absolute parameters for bumping x0 in warm start mode.
Definition at line 69 of file IpWarmStartIterateInitializer.hpp.
|
private |
Relative parameters for bumping x0 in warm start mode.
Definition at line 72 of file IpWarmStartIterateInitializer.hpp.
|
private |
Absolute parameters for bumping s0 in warm start mode.
Definition at line 75 of file IpWarmStartIterateInitializer.hpp.
|
private |
Relative parameters for bumping s0 in warm start mode.
Definition at line 78 of file IpWarmStartIterateInitializer.hpp.
|
private |
Parameters for bumping initial bound multipliers.
Definition at line 81 of file IpWarmStartIterateInitializer.hpp.
|
private |
Maximal size of entries in bound and equality constraint multipliers in magnitude.
If chosen less of equal to zero, no upper limit is imposed. Otherwise, the entries exceeding the given limit are set to the value closest to the limit.
Definition at line 90 of file IpWarmStartIterateInitializer.hpp.
|
private |
Target values for the barrier parameter in warm start option.
Definition at line 93 of file IpWarmStartIterateInitializer.hpp.
|
private |
Indicator for which method in the NLP should be used to get the warm start.
Definition at line 98 of file IpWarmStartIterateInitializer.hpp.
