RestoFilterConvergenceCheck Class Reference
#include <IpRestoFilterConvCheck.hpp>
Detailed Description
Convergence check for the restoration phase as called by the filter.This inherits from the OptimalityErrorConvergenceCheck so that the method for the regular optimality error convergence criterion can be checked as well. In addition, this convergence check returns the CONVERGED message, if the current iteration is acceptable to the original filter.
Since this object needs to know about the original NLP, it also inherits from RestoProblemCoupler, so that the restoration phase object can call the SetObjs method to set the corresponding pointers before the Initilize for the restoration phase algorithm is called.
Public Member Functions | |
| void | SetOrigFilterLSAcceptor (const FilterLSAcceptor &orig_filter_ls_acceptor) |
| Set the object for the original filter line search. | |
| virtual bool | InitializeImpl (const OptionsList &options, const std::string &prefix) |
| overloaded from AlgorithmStrategyObject | |
| virtual ConvergenceStatus | CheckConvergence (bool call_intermediate_callback=true) |
| overloaded from ConvergenceCheck | |
Constructors/Destructors | |
| RestoFilterConvergenceCheck () | |
| Default Constructor. | |
| virtual | ~RestoFilterConvergenceCheck () |
| Default destructor. | |
Static Public Member Functions | |
| static void | RegisterOptions (SmartPtr< RegisteredOptions > roptions) |
| Methods used by IpoptType. | |
Constructor & Destructor Documentation
| ~RestoFilterConvergenceCheck | ( | ) | [virtual] |
Member Function Documentation
| void SetOrigFilterLSAcceptor | ( | const FilterLSAcceptor & | orig_filter_ls_acceptor | ) |
Set the object for the original filter line search.
Here, filter_line_search must be the same strategy object to which the restoration phase object with this object is given. This method must be called to finish the definition of the algorithm, before Initialize is called.
| bool InitializeImpl | ( | const OptionsList & | options, | |
| const std::string & | prefix | |||
| ) | [virtual] |
overloaded from AlgorithmStrategyObject
Reimplemented from OptimalityErrorConvergenceCheck.
References DBG_ASSERT, OptionsList::GetIntegerValue(), OptionsList::GetNumericValue(), and OptimalityErrorConvergenceCheck::InitializeImpl().
| ConvergenceCheck::ConvergenceStatus CheckConvergence | ( | bool | call_intermediate_callback = true |
) | [virtual] |
overloaded from ConvergenceCheck
Reimplemented from OptimalityErrorConvergenceCheck.
References IpoptData::Append_info_string(), OptimalityErrorConvergenceCheck::CheckConvergence(), OptimalityErrorConvergenceCheck::constr_viol_tol_, ConvergenceCheck::CONTINUE, ConvergenceCheck::CONVERGED, ConvergenceCheck::CONVERGED_TO_ACCEPTABLE_POINT, IpoptData::curr(), IpoptCalculatedQuantities::curr_dual_infeasibility(), IpoptData::curr_mu(), DBG_ASSERT, CompoundVector::GetComp(), Ipopt::GetRawPtr(), IpoptData::info_alpha_dual(), IpoptData::info_alpha_primal(), IpoptData::info_ls_count(), IpoptData::info_regu_x(), IpoptNLP::IntermediateCallBack(), AlgorithmStrategyObject::IpCq(), AlgorithmStrategyObject::IpData(), AlgorithmStrategyObject::IpNLP(), FilterLSAcceptor::IsAcceptableToCurrentFilter(), FilterLSAcceptor::IsAcceptableToCurrentIterate(), Ipopt::IsValid(), IpoptData::iter_count(), Ipopt::J_DETAILED, Ipopt::J_LINE_SEARCH, Ipopt::J_MAIN, Ipopt::J_WARNING, AlgorithmStrategyObject::Jnlst(), Ipopt::Max(), ConvergenceCheck::MAXITER_EXCEEDED, Ipopt::Min(), Ipopt::NORM_MAX, RestoIpoptNLP::OrigIpCq(), RestoIpoptNLP::OrigIpData(), Journalist::Printf(), Ipopt::RestorationPhaseMode, IpoptData::Set_tol(), THROW_EXCEPTION, ConvergenceCheck::USER_STOP, and x.
| void RegisterOptions | ( | SmartPtr< RegisteredOptions > | roptions | ) | [static] |
Methods used by IpoptType.
Reimplemented from OptimalityErrorConvergenceCheck.
Referenced by Ipopt::RegisterOptions_Algorithm().
The documentation for this class was generated from the following files:
